API Documentation

eCampus RestAPI Backend (Laravel)

Hola, Tomás!

kukumowebs@gmail.com

Módulo Account

Este módulo gestiona el sistema multitenant del proyecto eCampus, donde cada instituto se representa como una "Account".

16 endpoints
Método URI
GET

api/v1/testing/insti

POST

api/v1/testing/insti

GET

api/v1/testing/insti/{id}

GET

api/v1/insti

POST

api/v1/insti

GET

api/v1/insti/{id}

GET

api/v1/insti/{id}/staff

POST

api/v1/insti/{id}/active-ciclo

POST

api/v1/insti/{id}/update

GET

api/v1/insti/{id}/users

POST

api/v1/insti/{id}/users/massive-import

POST

api/v1/insti/{id}/users/{userId}

GET

api/v1/insti/{id}/users/divisions

GET

api/v1/insti/{id}/users/roles-by-type

POST

api/v1/insti/{id}/reset-tyc

POST

api/v1/insti/{aid}/users/{id_user}

Módulo Auth

Este módulo se encarga del manejo de usuarios y la autenticación del sistema eCampus.

15 endpoints
Método URI
GET

api/v1/testing/user

GET

api/v1/testing/user/{id}

GET

api/v1/testing/user/{id}/login

POST

api/v1/auth/login

POST

api/v1/auth/userlogin

POST

api/v1/auth/register

POST

api/v1/auth/onboard

GET

api/v1/auth/me

GET

api/v1/auth/get-context

GET

api/v1/auth/get-context/{accountId}

POST

api/v1/auth/preferences

POST

api/v1/auth/context/refresh

POST

api/v1/auth/profile

POST

api/v1/auth/password

POST

api/v1/auth/logout

Calendar

Módulo para gestionar eventos de calendario por instituto (`id_account`) con visibilidad por tipo: - `1`: Privado (solo autor) - `2`: Staff (solo usuarios staff) - `3`: Público (todo el instituto) - `4`: Trabajos (obtenidos automáticamente de 09_wor...

4 endpoints
Método URI
GET

api/v1/insti/{aid}/calendar

POST

api/v1/insti/{aid}/calendar

POST

api/v1/insti/{aid}/calendar/upsert

POST

api/v1/insti/{aid}/calendar/{id}/delete

Módulo Ciclo

Este módulo gestiona los ciclos escolares (años lectivos) y sus respectivos periodos (trimestres, cuatrimestres, etc.) dentro del sistema eCampus.

11 endpoints
Método URI
GET

api/v1/insti/{aid}/ciclos

POST

api/v1/insti/{aid}/ciclos

GET

api/v1/insti/{aid}/ciclos/{ciclo}

PUT

api/v1/insti/{aid}/ciclos/{ciclo}

DELETE

api/v1/insti/{aid}/ciclos/{ciclo}

POST

api/v1/insti/{aid}/ciclos/create-empty

GET

api/v1/insti/{aid}/periodos

POST

api/v1/insti/{aid}/periodos

GET

api/v1/insti/{aid}/periodos/{periodo}

PUT

api/v1/insti/{aid}/periodos/{periodo}

DELETE

api/v1/insti/{aid}/periodos/{periodo}

Clone

2 endpoints
Método URI
GET

api/v1/insti/{aid}/ciclos/{cicloId}/clone-preview

POST

api/v1/insti/{aid}/ciclos/{cicloId}/clone

Comms

4 endpoints
Método URI
GET

api/v1/insti/{aid}/comms/inbox

POST

api/v1/insti/{aid}/comms/send

POST

api/v1/insti/{aid}/comms/{id}/read

POST

api/v1/insti/{aid}/comms/{id}/archive

CourseWork

The CourseWork module manages the "functional engine" of the LMS. It stores the content, configuration, and grades for all types of academic activities. While users interact with `08_lessons` in the Curricula, the system links those lessons to `09_wo...

11 endpoints
Método URI
GET

api/v1/insti/{aid}/groups/{gid}/coursework

GET

api/v1/insti/{aid}/groups/{gid}/coursework/all-grades

GET

api/v1/insti/{aid}/groups/{gid}/coursework/period-grades

POST

api/v1/insti/{aid}/groups/{gid}/coursework

GET

api/v1/insti/{aid}/groups/{gid}/coursework/{id}

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/grades

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/period-grades

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/responses

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/responses/{userId}/status

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/responses/{userId}/chat

POST

api/v1/insti/{aid}/groups/{gid}/coursework/{id}/responses/{userId}/chat/{index}/delete

Curricula Module

11 endpoints
Método URI
GET

api/v1/insti/{aid}/groups/{gid}/curricula

POST

api/v1/insti/{aid}/groups/{gid}/curricula/sections

POST

api/v1/insti/{aid}/groups/{gid}/curricula/sections/reorder

POST

api/v1/insti/{aid}/groups/{gid}/curricula/sections/{id}

POST

api/v1/insti/{aid}/groups/{gid}/curricula/sections/{id}/delete

POST

api/v1/insti/{aid}/groups/{gid}/curricula/lessons

POST

api/v1/insti/{aid}/groups/{gid}/curricula/lessons/reorder

GET

api/v1/insti/{aid}/groups/{gid}/curricula/lessons/{id}

POST

api/v1/insti/{aid}/groups/{gid}/curricula/lessons/{id}

POST

api/v1/insti/{aid}/groups/{gid}/curricula/lessons/{id}/delete

POST

api/v1/insti/{aid}/groups/{gid}/curricula/lessons/{lid}/progress

Feed

5 endpoints
Método URI
GET

api/v1/insti/{aid}/feeds/dashboard

GET

api/v1/insti/{aid}/groups/{gid}/feed

POST

api/v1/insti/{aid}/groups/{gid}/feed

POST

api/v1/insti/{aid}/groups/{gid}/feed/{id}/update

POST

api/v1/insti/{aid}/groups/{gid}/feed/{id}/delete

Ficheros Module

17 endpoints
Método URI
GET

api/v1/ficheros/s/{unique_id}

GET

api/v1/insti/{aid}/ficheros

POST

api/v1/insti/{aid}/ficheros

POST

api/v1/insti/{aid}/ficheros/folders

POST

api/v1/insti/{aid}/ficheros/responses

POST

api/v1/insti/{aid}/ficheros/external

GET

api/v1/insti/{aid}/ficheros/{id}

POST

api/v1/insti/{aid}/ficheros/{id}/update

POST

api/v1/insti/{aid}/ficheros/{id}/delete

GET

api/v1/insti/{aid}/ficheros/adjuntos/item/{itemId}

POST

api/v1/insti/{aid}/ficheros/adjuntos

POST

api/v1/insti/{aid}/ficheros/adjuntos/{id}/delete

GET

api/v1/insti/{aid}/groups/{gid}/ficheros

POST

api/v1/insti/{aid}/groups/{gid}/ficheros

POST

api/v1/insti/{aid}/groups/{gid}/ficheros/folders

POST

api/v1/insti/{aid}/groups/{gid}/ficheros/responses

POST

api/v1/insti/{aid}/groups/{gid}/ficheros/external

Módulo GEO (Geolocalización)

Este módulo gestiona la información geográfica de provincias y localidades, permitiendo la búsqueda de institutos por zona.

4 endpoints
Método URI
GET

api/v1/geo/provincias

GET

api/v1/geo/provincias/{id_provincia}/localidades

GET

api/v1/geo/localidades/search

GET

api/v1/geo/localidades/{id}

Módulo Group

Este módulo gestiona la organización de usuarios en diferentes tipos de agrupaciones académicas y sociales, así como la estructura jerárquica de la institución.

25 endpoints
Método URI
GET

api/v1/insti/{aid}/groups/my-groups

GET

api/v1/insti/{aid}/groups

POST

api/v1/insti/{aid}/groups

GET

api/v1/insti/{aid}/groups/{id}

POST

api/v1/insti/{aid}/groups/{id}/update

POST

api/v1/insti/{aid}/groups/{id}/delete

GET

api/v1/insti/{aid}/groups/{id}/members

GET

api/v1/insti/{aid}/groups/{id}/links

GET

api/v1/insti/{aid}/groups/{id}/divisions

GET

api/v1/insti/{aid}/groups/{id}/subject-members

GET

api/v1/insti/{aid}/groups/{id}/area-groups

GET

api/v1/insti/{aid}/catalogos/students-by-division

GET

api/v1/insti/{aid}/catalogos/staff-by-role

GET

api/v1/insti/{aid}/catalogos/students

GET

api/v1/insti/{aid}/catalogos/tutors

POST

api/v1/insti/{aid}/catalogos/link-student-tutor

POST

api/v1/insti/{aid}/catalogos/assign-divisions

POST

api/v1/insti/{aid}/catalogos/change-students-role

POST

api/v1/insti/{aid}/group-links

POST

api/v1/insti/{aid}/group-links/{id}/delete

GET

api/v1/insti/{aid}/estructuras

POST

api/v1/insti/{aid}/estructuras

POST

api/v1/insti/{aid}/estructuras/reorder

POST

api/v1/insti/{aid}/estructuras/{id}/update

POST

api/v1/insti/{aid}/estructuras/{id}/delete

Módulo Journal

9 endpoints
Método URI
DELETE

api/v1/fechas/{fecha}

GET

api/v1/fechas

POST

api/v1/fechas

GET

api/v1/fechas/{fecha}

PUT

api/v1/fechas/{fecha}

GET

api/v1/asistencias

POST

api/v1/asistencias/upsert

GET

api/v1/conductas

POST

api/v1/conductas/upsert

Módulo Marketplace

Este módulo gestiona la capa comercial y de capacidades de la plataforma. A diferencia de los módulos técnicos que operan en la infraestructura, el Marketplace permite a cada cuenta (instituto) activar o adquirir funcionalidades específicas según sus...

5 endpoints
Método URI
GET

api/v1/marketplace/modules

GET

api/v1/marketplace/account/{accountId}

POST

api/v1/marketplace/toggle

POST

api/v1/marketplace/config

POST

api/v1/marketplace/purchase

Monedero

11 endpoints
Método URI
GET

api/v1/{accountId}/{groupId}/monedero/balances

POST

api/v1/{accountId}/{groupId}/monedero/adjust

GET

api/v1/{accountId}/{groupId}/monedero/history

GET

api/v1/{accountId}/{groupId}/monedero/inventory

POST

api/v1/{accountId}/{groupId}/monedero/inventory/{id}/use

GET

api/v1/{accountId}/{groupId}/monedero/rewards

POST

api/v1/{accountId}/{groupId}/monedero/rewards

POST

api/v1/{accountId}/{groupId}/monedero/rewards/{id}/purchase

GET

api/v1/{accountId}/{groupId}/monedero/rewards/{id}

POST

api/v1/{accountId}/{groupId}/monedero/rewards/{id}

POST

api/v1/{accountId}/{groupId}/monedero/rewards/{id}/delete

Módulo QR

Módulo para el control de ingresos y egresos de los alumnos a la institución mediante el escaneo de un código QR identificatorio o el ingreso manual de su DNI.

7 endpoints
Método URI
GET

api/v1/insti/{aid}/qr/fechas

POST

api/v1/insti/{aid}/qr/fechas

POST

api/v1/insti/{aid}/qr/fechas/{id_fecha}

GET

api/v1/insti/{aid}/qr/fechas/{id_fecha}/asistencias

GET

api/v1/insti/{aid}/qr/user/{identifier}

POST

api/v1/insti/{aid}/qr/user/{userId}/qr

POST

api/v1/insti/{aid}/qr/scan

Módulo RBAC (Role-Based Access Control)

Este módulo gestiona el sistema de roles y permisos para los usuarios del sistema eCampus (alumnos, profesores, directivos, padres, etc.).

5 endpoints
Método URI
GET

api/v1/insti/{aid}/rbac/me

GET

api/v1/insti/{aid}/rbac/roles

POST

api/v1/insti/{aid}/rbac/roles

POST

api/v1/insti/{aid}/rbac/assign

GET

api/v1/insti/{aid}/rbac/user/{id_user}

Módulo Report

22 endpoints
Método URI
GET

api/v1/insti/{aid}/report/tracking

GET

api/v1/insti/{aid}/report/preview-tracking/{trackingId}

POST

api/v1/insti/{aid}/report/tracking/bulk

GET

api/v1/insti/{aid}/report/custom-fields

POST

api/v1/insti/{aid}/report/custom-fields

POST

api/v1/insti/{aid}/report/custom-fields/{id}/delete

GET

api/v1/insti/{aid}/report/templates

POST

api/v1/insti/{aid}/report/templates

GET

api/v1/insti/{aid}/report/templates/{id}

POST

api/v1/insti/{aid}/report/templates/{id}

POST

api/v1/insti/{aid}/report/templates/{id}/delete

GET

api/v1/insti/{aid}/groups/{gid}/report

POST

api/v1/insti/{aid}/groups/{gid}/report

GET

api/v1/insti/{aid}/groups/{gid}/report/matrix

POST

api/v1/insti/{aid}/groups/{gid}/report/{id}/sync

GET

api/v1/insti/{aid}/groups/{gid}/report/{id}

POST

api/v1/insti/{aid}/groups/{gid}/report/{id}/delete

GET

api/v1/insti/{aid}/groups/{gid}/report/{id}/values

POST

api/v1/insti/{aid}/groups/{gid}/report/{id}/values

GET

api/v1/insti/{aid}/groups/{gid}/report/{id}/preview

POST

api/v1/insti/{aid}/groups/{gid}/report/{id}/approve/{alumnoId}

POST

api/v1/insti/{aid}/groups/{gid}/report/{id}/send/{alumnoId}

Módulo Rubric

5 endpoints
Método URI
GET

api/v1/rubrics

POST

api/v1/rubrics

GET

api/v1/rubrics/{rubric}

PUT

api/v1/rubrics/{rubric}

DELETE

api/v1/rubrics/{rubric}

Sadmin

3 endpoints
Método URI
GET

api/v1/sadmin/accounts

POST

api/v1/sadmin/accounts/{id}

POST

api/v1/sadmin/accounts/{id}/status

Schedule Module (Horarios)

Módulo para la gestión de plantillas de horarios semanales y asignación de grupos a bloques horarios.

9 endpoints
Método URI
GET

api/v1/insti/{aid}/schedules

GET

api/v1/insti/{aid}/schedules/{id}

POST

api/v1/insti/{aid}/schedules/store

POST

api/v1/insti/{aid}/schedules/delete

POST

api/v1/insti/{aid}/schedules/blocks/upsert

POST

api/v1/insti/{aid}/schedules/assignments/upsert

POST

api/v1/insti/{aid}/schedules/assignments/delete

GET

api/v1/insti/{aid}/schedules/view/group

GET

api/v1/insti/{aid}/schedules/view/user

Módulo Support

Módulo de soporte para gestión de tickets por instituto.

6 endpoints
Método URI
GET

api/v1/insti/{aid}/support

GET

api/v1/insti/{aid}/support/tic

POST

api/v1/insti/{aid}/support

GET

api/v1/insti/{aid}/support/{id}

POST

api/v1/insti/{aid}/support/{id}/reply

POST

api/v1/insti/{aid}/support/{id}/update

Módulo User

este módulo no posee models y controllers propios, es solo un contenedor de rutas para simplificar el acceso a endpoints de los otros módulos, de parte del cliente. # Rutas - GET /api/v1/insti/{id_insti}/users/{id_user}/ - GET /api/v1/insti/{id_ins...

4 endpoints
Método URI
GET

api/v1/insti/{aid}/users/{id_user}

GET

api/v1/insti/{aid}/users/{id_user}/groups

GET

api/v1/insti/{aid}/users/{id_user}/roles

POST

api/v1/insti/{aid}/users/{id_user}/institutional-image

Otros Endpoints

Rutas generales del sistema o sin módulo asignado explícitamente.

12 endpoints
Método URI
GET

api/v1/backups

POST

api/v1/backups

POST

api/v1/backups/restore

DELETE

api/v1/backups/batch

GET

api/v1/backups/settings

POST

api/v1/backups/settings

GET

api/v1/backups/download

GET

api/v1

GET

up

GET

/

GET

{fallbackPlaceholder}

GET

storage/{path}