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

  • GET /courses- lista de cursos
  • GET /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 curso
  • PUT /courses/{courseId}/groups/{groupId}- inscribir a un grupo de usuarios en un curso
  • DELETE /courses/{courseId}/users/{userId}- anular la inscripción de un solo usuario de un curso
  • DELETE /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 nuevo
  • GET /groups- enumerar grupos
  • GET /groups/{groupId}- obtener detalles de un grupo por identificador de grupo
  • PUT /groups/{groupId}- actualizar un grupo por identificador de grupo
  • DELETE /groups/{groupId}- eliminar un grupo por identificador de grupo

API de membresías de grupos

  • GET /groups/{groupId}/users- enumerar los miembros de un grupo
  • GET /users/{userId}/groups - enumerar los grupos de un usuario
  • PUT /groups/{groupId}/users/{userId} - agregar un usuario a un grupo
  • DELETE /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 equipo
  • GET /invitations—enumerar las invitaciones pendientes
  • GET /invitations/{invitationId}—obtener los detalles de una invitación pendiente mediante el identificador de la invitación
  • DELETE /invitations/{invitationId}—eliminar una invitación pendiente mediante el identificador de invitación

API Learning Paths

  • GET /learning-paths- enumerar las rutas de aprendizaje
  • GET /learning-paths/{learningPathId}- obtener detalles de una ruta de aprendizaje mediante el identificador de la ruta de aprendizaje
  • GET /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 aprendizaje
  • PUT /learning-paths/{learningPathId}/groups/{groupId}- inscribir a un grupo de usuarios en una ruta de aprendizaje
  • DELETE /learning-paths/{learningPathId}/users/{userId}- anular la inscripción de un solo usuario de una ruta de aprendizaje
  • DELETE /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 usuarios
  • GET /users/{userId}- obtener los detalles de un usuario por seudónimo
  • DELETE /users/{userId} - eliminar un usuario por su seudónimo

API de Webhooks

  • POST /webhooks- crear un nuevo webhook
  • GET /webhooks- lista de webhooks
  • GET /webhooks/{webhookId}- obtener detalles de un webhook mediante el identificador del webhook
  • DELETE /webhooks/{webhookId}- eliminar un webhook por el identificador del webhook