Documentación de la API

Cada institución tiene su propia documentación interactiva de la API, disponible en /docs/ a partir de la dirección de su Eduvem - por ejemplo, https://love.eduvem.com/docs/. Es el material que el equipo técnico responsable de la integración (RH, ERP, BI o cualquier sistema externo) usará para conocer y probar la API antes de escribir cualquier código.

Qué encuentra allí

La documentación reúne todos los endpoints de la API de integración: parámetros aceptados, esquemas de solicitud y de respuesta, y los alcances (scopes) exigidos por cada llamada. La página es interactiva - puede expandir cualquier endpoint, completar los parámetros y enviar la solicitud directamente desde el navegador, usando un token real, sin necesitar Postman ni ninguna otra herramienta externa.

Dónde encontrar el enlace

En la pestaña Integraciones de la configuración de la institución (Institución > Integraciones), la sección Configuración de la API para Integraciones incluye:

• El enlace Documentación de la API, que abre el /docs/ de su institución.
• La URL de la API, ya lista para copiar - la dirección base usada en toda llamada de integración.

Consejo

Cada institución tiene su propia documentación, en su propio dominio. Si usted administra o integra más de una Eduvem, confirme siempre cuál /docs/ está usando - el de cada institución es diferente.

Autenticación

Para probar una llamada directamente en la documentación interactiva - o para configurar una integración real - usted necesita un token de la API válido. La creación, la revocación y los alcances de los tokens se gestionan en la misma pestaña Integraciones: consulte Tokens de la API de integración. Sin un token, la documentación sigue siendo navegable y cada endpoint permanece visible, pero el botón para enviar la solicitud devuelve un error de autenticación.

Clases de un contenido

Una integración que trata cada clase como una tarea propia - un plan de desarrollo individual en un sistema de RRHH, por ejemplo - puede consultar la lista de clases de un contenido y, por matrícula, el estado de cada una:

• GET /integrations/courseVersions/{courseVersionUUID}/lessons devuelve la lista ordenada y de solo lectura de las clases del contenido publicado - clases del wizard agrupadas por módulo, los SCOs de un paquete SCORM, o la unidad única de un coursebox.
• GET /integrations/enrollments/{enrollmentUUID}/lessons devuelve la misma lista para una matrícula específica, con el estado “visualizada”/“completada” de cada clase y el progreso general de la matrícula.

Ambas llamadas tienen su propio límite de uso: 120 solicitudes por minuto, por institución, para cada una.

Todos los campos, alcances y ejemplos completos de cada endpoint están en la documentación interactiva de la API de su institución (arriba).

Consejo

El identificador de cada clase (lessonKey) es la identidad de la clase; su posición en la lista (position) es solo el orden de visualización - si un autor reordena las clases, la posición cambia, pero el lessonKey sigue siendo el mismo. La estabilidad del lessonKey también varía según el tipo de contenido: los identificadores de las clases del wizard se mantienen incluso después de una nueva publicación o de una traducción. Los identificadores de las clases SCORM, en cambio, son las propias rutas de archivo del paquete: los identificadores pueden cambiar o desaparecer si el paquete se reemplaza por una nueva versión o, en la consulta por matrícula, cuando el primer acceso del participante fija un idioma cuyo paquete trae archivos diferentes. Una integración que guarda este identificador (para hacer seguimiento de tareas, por ejemplo) necesita resincronizar después de cualquiera de estos cambios. La mayoría de los contenidos SCORM tiene una única clase.

Vea también

• Tokens de la API de integración