Browse Articles

Browse Articles

Reach 360: Introducción a la API Reach 360

Artículo actualizado el

Este artículo se aplica a:

Reach 360

La API Reach 360 se organiza en torno a REST. Nuestra API tiene direcciones URL predecibles orientadas a los recursos, acepta cuerpos de solicitud codificados en JSON, devuelve respuestas codificadas en JSON y utiliza códigos de respuesta HTTP estándar, autenticación y verbos.

Para ver las actualizaciones más recientes, consulta el registro de cambios.

Haga clic aquí para obtener información sobre cómo generar claves de API en Reach 360.

Autentic

Su clave de API se utiliza para autenticar las solicitudes e identificar su cuenta de Reach 360. Debe almacenarse de forma segura: asegúrese de mantenerla fuera del control de versiones y que solo puedan acceder a ella quienes la necesiten. Trátela como cualquier otra contraseña.

Todas las solicitudes de API deben usar la autenticación de portador: tu clave de API debe proporcionarse como un token de portador en el Authorization encabezado. Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP simple fallarán. Las solicitudes de API sin autenticación también fallarán.

Control de versiones

Cuando se realicen cambios en nuestra API que no sean compatibles con versiones anteriores, publicaremos una versión nueva y anticuada de la API. Se utilizará la versión inicial de la 2023-04-04 API cuando tus solicitudes no incluyan un encabezado. API-Version

Si se proporciona un encabezado de versión de API no válido, recibirás una respuesta 400 con el código de errorinvalid_api_version. Las solicitudes de API correctas incluirán un encabezado de API-Version respuesta que indica la versión de API con la que se procesó la solicitud.

Cada vez que se publica una nueva versión de la API, la incluimos de forma explícita en nuestro registro de cambios, además de crear una nueva entrada en la página de versiones de la API.

Ejemplo de solicitud

curl -i < https://api.reach360.com/users >\\ 
 -H «Autorización: portador $API_KEY» -H «Versión de API: 16-07-2020»

Paginación

Todos los puntos finales paginados se basan en el cursor y devuelven una propiedad. nextUrl Si nonull, nextUrl indica que puede haber resultados adicionales. Se puede realizar una GET solicitud a la nextUrl URL para obtener la siguiente página de resultados. Un nextUrl número de null indica que no hay más resultados. Todos los puntos finales paginados admiten un parámetro de cadena de limit consulta que especifica el número máximo de resultados que se devolverán en una sola respuesta. Todos los puntos finales que devuelven una lista de resultados admiten la paginación.

Nota: El limit valor debe estar comprendido entre 1 y 100 (salvo que se indique lo contrario; si no se especifica, el valor predeterminado es 50).

Puntos finales compatibles con la paginación

  • GET /courses
  • GET /groups
  • GET /groups/{groupId}/users
  • GET /invitations
  • GET /learning-paths
  • GET /learning-paths/{learningPathId}
  • GET /learning-paths/{learningPathId}/courses
  • GET /reports/activity
  • GET /reports/courses/{courseId}
  • GET /reports/learners/{userId}
  • GET /reports/learning-paths/{learningPathId}/courses
  • GET /reports/learning-paths/{learningPathId}/learners
  • GET /users
  • GET /users/{userId}/groups
  • GET /webhooks

Errores

Cuando la solicitud no sea válida, se errors devolverá una respuesta de 400 que contenga una lista de. Algunos códigos de error comunes incluyen:

  • validation_failed: El cuerpo de la solicitud tiene un error de validación
  • invalid_email: La email propiedad no es una dirección de correo electrónico con el formato correcto
  • missing_api_key: Falta una clave de API en la solicitud
  • invalid_api_key: La clave de API proporcionada no es válida
  • invalid_content_type: Falta la solicitud o tiene un tipo de contenido incorrecto

Ejemplo de respuesta

{
«errors»: [
{
«code»: «invalid_email», 
 «message»: «\\" email\\» debe ser un correo electrónico válido»
}]}

Soporte

Nos entusiasma que conecte Reach 360 con las herramientas que más utiliza. El equipo de soporte puede confirmar si las llamadas a la API funcionan según lo esperado, pero no podemos ayudarte a escribir scripts personalizados ni a depurar aplicaciones de terceros.

Si tienes algún problema, haremos todo lo que esté a nuestro alcance para ayudarte a resolverlo solicitándote lo siguiente:

  • La versión más sencilla de la llamada que estás realizando con la API
  • Si el problema se puede replicar fuera de la aplicación
  • Encabezados de solicitud, encabezados de respuesta (incluido el encabezado X-Request-Id), cuerpos de solicitud y cuerpos de respuesta

Ponte en contacto con nuestro equipo y cuéntanos qué está pasando. ¡Nos ocuparemos de ahí!