Skip to main content

​
Base URL

All API endpoints are accessible at: 
/api

​
Authentication

All API endpoints use Laravel Sanctum authentication with the auth:sanctum middleware.
To access protected endpoints, you must include a valid Bearer token in the Authorization header: 
Authorization: Bearer {your-token}

​
HTTP Methods

The API follows RESTful conventions using standard HTTP methods:
  • GET: Retrieve resources
  • POST: Create new resources
  • PUT/PATCH: Update existing resources
  • DELETE: Remove resources
All resource endpoints are registered as apiResource routes, providing the following methods:
MethodEndpointAction
GET/api/{resource}List all resources
POST/api/{resource}Create a new resource
GET/api/{resource}/{id}Get a specific resource
PUT/PATCH/api/{resource}/{id}Update a resource
DELETE/api/{resource}/{id}Delete a resource

​
Available Endpoints

​
Institutions & Users

Institutions

Manage educational institutions

Users

Manage user accounts and profiles

Registrations

Handle student course registrations

​
Academic Structure

Sections

Manage course sections and classes

Units

Organize curriculum units

Topics

Handle learning topics within units

​
Learning Resources

Resources

Manage learning materials and resources

Questions

Create and manage assessment questions

Response Options

Define answer choices for questions

​
Evaluations

Evaluations

Create and manage evaluations

Evaluation Questions

Link questions to evaluations

​
Resource Endpoints Summary

The following resource endpoints are available: 
# Institutions & Users
GET|POST    /api/institutions
GET|PUT|DELETE /api/institutions/{id}

GET|POST    /api/users
GET|PUT|DELETE /api/users/{id}

GET|POST    /api/registrations
GET|PUT|DELETE /api/registrations/{id}

# Academic Structure
GET|POST    /api/sections
GET|PUT|DELETE /api/sections/{id}

GET|POST    /api/units
GET|PUT|DELETE /api/units/{id}

GET|POST    /api/topics
GET|PUT|DELETE /api/topics/{id}

# Learning Resources
GET|POST    /api/resources
GET|PUT|DELETE /api/resources/{id}

GET|POST    /api/questions
GET|PUT|DELETE /api/questions/{id}

GET|POST    /api/response_option
GET|PUT|DELETE /api/response_option/{id}

# Evaluations
GET|POST    /api/evaluations
GET|PUT|DELETE /api/evaluations/{id}

GET|POST    /api/eval_preguntas
GET|PUT|DELETE /api/eval_preguntas/{id}
All endpoints follow the same response format. See Response Format for details.

​
Getting Started

  1. Authenticate using Laravel Sanctum to obtain a Bearer token
  2. Include the token in the Authorization header for all requests
  3. Use the appropriate HTTP method and endpoint for your operation
  4. Handle responses according to the standard format
For detailed information about each endpoint, see the specific resource documentation pages.

Build docs developers (and LLMs) love

Get started for freeTalk to us