Reach 360 : Présentation de l'API Reach 360

L'API Reach 360 est organisée autour de REST. Notre API possède des URL prévisibles orientées vers les ressources, accepte les corps de requêtes codés en JSON, renvoie des réponses codées en JSON et utilise des codes de réponse HTTP, une authentification et des verbes standard.

Vos demandes d'API Reach 360 utiliseront l'URL https://api.reach360.com. Pour les dernières mises à jour, consultez le Changelog.

Cliquez ici pour savoir comment générer des clés d'API dans Reach 360.

• Authentification
• Gestion des versions
• Pagination
• Des erreurs
• Soutenir

Authentification

Votre clé API est utilisée pour authentifier les demandes et identifier votre compte Reach 360. Il doit être stocké en toute sécurité : assurez-vous qu'il n'est pas soumis au contrôle de version et qu'il n'est accessible qu'aux personnes qui en ont besoin. Traitez-le comme n'importe quel autre mot de passe.

Toutes les demandes d'API doivent utiliser l'authentification au porteur : votre clé d'API doit être fournie sous forme de jeton porteur dans l'Authorizationen-tête. Toutes les demandes d'API doivent être effectuées via HTTPS. Les appels effectués via HTTP simple échoueront. Les demandes d'API sans authentification échoueront également.

Gestion des versions

Lorsque des modifications non rétrocompatibles sont apportées à notre API, nous publions une nouvelle version datée de l'API. La version initiale de l'API2023-04-04 sera utilisée lorsque vos demandes n'incluent pas d'API-Versionen-tête.

Lorsqu'un en-tête de version d'API non valide est fourni, vous recevez une réponse 400 avec le code d'erreurinvalid_api_version. Les demandes d'API réussies incluront un en-tête deAPI-Version réponse indiquant la version d'API utilisée pour le traitement de votre demande.

Chaque fois qu'une nouvelle version de l'API est publiée, nous l'indiquons explicitement dans notre journal des modifications, en plus de créer une nouvelle entrée sur la page des versions de l'API.

Exemple de demande

curl -i < https://api.reach360.com/users > \ \
 -H « Autorisation : titulaire de $API_KEY »
 -H « Version de l'API : 16/07/2020 »

Pagination

Tous les points de terminaison paginés sont basés sur un curseur et renvoient unenextUrl propriété. Si ce n'est pasnull le cas, celanextUrl indique qu'il peut y avoir des résultats supplémentaires. UneGET demande peut être faite à l'nextUrlURL pour obtenir la page de résultats suivante. UnnextUrl denull indique qu'il n'y a pas d'autres résultats. Tous les points de terminaison paginés prennent en support technique un paramètre de chaîne delimit requête qui spécifie le nombre maximum de résultats à renvoyer dans une seule réponse. Tous les terminaux qui renvoient une liste de résultats support technique la pagination.

Remarque : Lalimit valeur doit être comprise entre 1 et 100 (sauf indication contraire ; la valeur par défaut est 50 si elle n'est pas spécifiée).

Points de terminaison prenant en charge la pagination

• 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

Des erreurs

Une réponse 400 contenant une liste deerrors sera renvoyée lorsque la demande n'est pas valide. Les codes d'erreur les plus courants sont les suivants :

• validation_failed: le corps de la requête contient une erreur de validation
• invalid_email: laemail propriété n'est pas une adresse e-mail correctement formatée
• missing_api_key: il manque une clé d'API à la demande
• invalid_api_key: La clé API fournie n'est pas valide

Exemple de réponse

{
« errors » : [
{
« code » : « invalid_email »,
 « message » : « \ \" email \ \ » doit être un e-mail valide »
}
]
}

Soutenir

Nous sommes ravis que vous puissiez connecter Reach 360 aux outils que vous utilisez le plus. Le support peut confirmer si les appels d'API fonctionnent comme prévu, mais nous ne pouvons pas vous aider à écrire un script personnalisé ou à déboguer des applications tierces.

Si vous rencontrez un problème, nous ferons de notre mieux pour vous aider à le résoudre en vous demandant :

• La version la plus simple de l'appel que vous passez avec l'API
• Si le problème peut être répliqué en dehors de votre application
• En-têtes de demande, en-têtes de réponse (y compris l'en-tête X-Request-Id), corps de demande et corps de réponse

Contactez notre équipe et dites-nous ce qui se passe. Nous nous en occuperons à partir de là !