Reach 360: Guía de referencia de terminales de API
Artículo actualizado el
Este artículo se aplica a:
En este artículo se enumeran todos los puntos finales de Reach 360. Las API completas e individuales están vinculadas en cada sección.
- API de cursos
- API de inscripción a cursos
- API de favoritos
- API de grupos
- API de membresías de grupos
- API de importación de finalización de cursos
- API de invitaciones
- API de rutas de aprendizaje
- API de inscripciones de Learning Path
- API de informes
- API de usuarios
- API de Webhooks
API de cursos
GET /courses
- lista de cursosGET /courses/{courseId}
- obtener detalles de un curso por identificador de curso
API de inscripción a cursos
PUT /courses/{courseId}/users/{userId}
- inscribir a un solo usuario en un cursoPUT /courses/{courseId}/groups/{groupId}
- inscribir a un grupo de usuarios en un cursoDELETE /courses/{courseId}/users/{userId}
- anular la inscripción de un solo usuario de un cursoDELETE /courses/{courseId}/groups/{groupId}
- anular la inscripción de un grupo de usuarios de un curso
API de favoritos
-
GET /users/{userId}/favorites
- enumerar los cursos y las rutas de aprendizaje en los favoritos de un usuario
API de grupos
POST /groups
- crear un grupo nuevoGET /groups
- enumerar gruposGET /groups/{groupId}
- obtener detalles de un grupo por identificador de grupoPUT /groups/{groupId}
- actualizar un grupo por identificador de grupoDELETE /groups/{groupId}
- eliminar un grupo por identificador de grupo
API de membresías de grupos
GET /groups/{groupId}/users
- enumerar los miembros de un grupoGET /users/{userId}/groups
- enumerar los grupos de un usuarioPUT /groups/{groupId}/users/{userId}
- agregar un usuario a un grupoDELETE /groups/{groupId}/users/{userId}
- eliminar un usuario de un grupo
Importar la API de finalización de cursos
-
POST /courses/{courseId}/users/{userId}/completions
- importe los datos de finalización de un solo par de curso/usuario a Reach 360.
API de invitaciones
POST /invitations
—envía una invitación a un usuario para que se una a tu equipoGET /invitations
—enumerar las invitaciones pendientesGET /invitations/{invitationId}
—obtener los detalles de una invitación pendiente mediante el identificador de la invitaciónDELETE /invitations/{invitationId}
—eliminar una invitación pendiente mediante el identificador de invitación
API Learning Paths
GET /learning-paths
- enumerar las rutas de aprendizajeGET /learning-paths/{learningPathId}
- obtener detalles de una ruta de aprendizaje mediante el identificador de la ruta de aprendizajeGET /learning-paths/{learningPathId}/courses
- enumerar los cursos en una ruta de aprendizaje por ID de ruta de aprendizaje
API de inscripciones de Learning Path
PUT /learning-paths/{learningPathId}/users/{userId}
- inscribir a un solo usuario en una ruta de aprendizajePUT /learning-paths/{learningPathId}/groups/{groupId}
- inscribir a un grupo de usuarios en una ruta de aprendizajeDELETE /learning-paths/{learningPathId}/users/{userId}
- anular la inscripción de un solo usuario de una ruta de aprendizajeDELETE /learning-paths/{learningPathId}/groups/{groupId}
- anular la inscripción de un grupo de usuarios de una ruta de aprendizaje
API de informes
GET /reports/activity
- informe de actividad del usuario (lista de sesiones de usuario)GET /reports/courses/{courseId}
- informe de los alumnos del curso (lista de las sesiones de los alumnos de un curso)GET /reports/learners/{userId}
- informe del curso del alumno (lista de las sesiones del curso para un alumno)GET /reports/learning-paths/{learningPathId}/courses
- informe de cursos de la ruta de aprendizaje (lista de las sesiones del curso en una ruta de aprendizaje)GET /reports/learning-paths/{learningPathId}/learners
- informe de los alumnos sobre la ruta de aprendizaje (lista de las sesiones de los alumnos en una ruta de aprendizaje)
API de usuarios
GET /users
- lista de usuariosGET /users/{userId}
- obtener los detalles de un usuario por seudónimoDELETE /users/{userId}
- eliminar un usuario por su seudónimo
API de Webhooks
POST /webhooks
- crear un nuevo webhookGET /webhooks
- lista de webhooksGET /webhooks/{webhookId}
- obtener detalles de un webhook mediante el identificador del webhookDELETE /webhooks/{webhookId}
- eliminar un webhook por el identificador del webhook