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 URL predecibles orientadas a los recursos, acepta cuerpos de solicitudes codificados en JSON, devuelve respuestas codificadas en JSON y usa códigos de respuesta HTTP estándar, autenticación y verbos.

Sus solicitudes de API de Reach 360 utilizarán la URL https://api.reach360.com. Para ver las actualizaciones más recientes, consulta el registro de cambios.

Haz clic aquí para aprender a generar claves de API en Reach 360.

Autentificación

Su clave de API se usa para autenticar las solicitudes e identifica su cuenta de Reach 360. Debe almacenarse de forma segura: asegúrese de que se mantenga fuera del control de versiones y que solo puedan acceder a él quienes lo necesiten. Trátela como cualquier otra contraseña.

Todas las solicitudes de API deben utilizar la autenticación portadora: la clave de API debe proporcionarse como un token de portador en elAuthorization 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 de la API nueva y anticuada. Se2023-04-04 asumirá la versión inicial de la API cuando las solicitudes no incluyan unAPI-Version encabezado.

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 exitosas incluirán un encabezado deAPI-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 mencionamos explícitamente 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 extremos paginados se basan en cursores y devuelven unanextUrl propiedad. Si no esnextUrl asínull, indica que puede haber resultados adicionales. Se puede realizar unaGET solicitud a lanextUrl URL para obtener la siguiente página de resultados. UnnextUrl valor denull indica que no hay más resultados. Todos los extremos paginados soporte técnico un parámetro de cadena delimit consulta que especifica el número máximo de resultados que se deben devolver en una sola respuesta. Todos los extremos que devuelven una lista de resultados soporte técnico la paginación.

Nota: Ellimit valor debe estar comprendido entre 1 y 100 (excepto si se indica lo contrario; el valor predeterminado es 50 si no se especifica).

Terminales que admiten 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, seerrors devolverá una respuesta 400 con 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: Laemail 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

Ejemplo de respuesta

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

Soporte

Nos alegra que puedas conectar Reach 360 con las herramientas que más utilizas. El equipo de soporte puede confirmar si las llamadas a la API funcionan como se esperaba, pero no podemos ayudarte a escribir scripts personalizados ni a depurar aplicaciones de terceros.

Si tienes algún problema, haremos todo lo posible para ayudarte a solucionarlo solicitándote lo siguiente:

  • La versión más simple 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 solicitudes y cuerpos de respuesta

Ponte en contacto con nuestro equipo y cuéntanos qué está pasando. ¡Nosotros nos encargaremos de eso!