Open API

Dans ASAP, vous pouvez utiliser Open API pour interagir avec des solutions tierces. Open API fonctionne via HTTP et offre un ensemble de méthodes de demande/réponse.

Les demandes d'API doivent être envoyées à l'adresse suivante :

<URL du portail ASAP, qui est utilisé pour interagir via Open API>/openapi/<version de l'API>/<request>

Comment obtenir l'URL ASAP, qui est utilisée pour interagir via l'API

Pour obtenir une URL ASAP d'Open API :

1. Connectez-vous à la plateforme web ASAP.
2. Dans la section Tableau de bord, cliquez sur le bouton Importation et synchronisation, puis ouvrez l'onglet Open API.
3. Le lien pour contacter ASAP via Open API se trouve en bas de la fenêtre. Copiez et enregistrez-le de la façon qui vous convient.

Comment activer l'accès via l'API et générer un jeton

Pour que les demandes puissent être autorisées, elles doivent être signées par un jeton créé sur la plateforme ASAP. Seuls les administrateurs de l'entreprise peuvent créer des jetons.

Pour créer un jeton, procédez comme suit :

1. Connectez-vous à la plateforme web ASAP.
2. Dans la section Tableau de bord, cliquez sur le bouton Importation et synchronisation, puis ouvrez l'onglet Open API.
3. Cliquez sur le bouton Nouveau jeton.

   La fenêtre Obtenir un jeton s'ouvre.

4. Copiez le jeton et enregistrez-le de la façon qui vous convient.

Le jeton n'est pas stocké dans le système ASAP accessible au public. Après avoir fermé la fenêtre Obtenir un jeton, il ne sera plus disponible à la visualisation. Si vous avez fermé cette fenêtre sans copier le jeton, vous devez de nouveau cliquer sur Nouveau jeton pour que le système génère un nouveau jeton.

Le jeton émis est valable pendant 12 mois. À l'expiration de cette période, le jeton est révoqué. Le jeton émis est également révoqué s'il n'est pas utilisé pendant 6 mois.

Autorisation

Le jeton obtenu sur ASAP doit être ajouté aux en-têtes de toutes les demandes d'API. L'en-tête devrait ressembler à ce qui suit :

Format de la réponse

JSON est le format par défaut des réponses aux demandes d'API.

Exemple d'un appel CURL

Voici une demande d'API à l'adresse https://domain.com/, qui utilise la méthode « GET openapi/v1/groups » (obtenir une liste de groupes). La demande s'authentifie en utilisant le jeton e8c699c05d495566a94bbb6841894153.

Méthodes ASAP d'Open API utilisées pour intégrer les systèmes de gestion de l'apprentissage (SGA)

Voici les méthodes disponibles d'intégration aux systèmes de gestion de l'apprentissage :

1. /users/info : obtenir un lien personnel vers le portail utilisateur.
2. /groups : obtenir une liste des groupes disponibles pour cette entreprise.
3. /users : créer un utilisateur et l'ajouter au groupe indiqué.
4. /report : générer des données de rapport sur les utilisateurs qui sont enregistrés sur le portail et qui suivent une formation sur les programmes ASAP.
5. /user : apporter des modifications aux données de l'utilisateur. Déplacement d'un employé de l'entreprise vers un autre groupe de formation.

Chaque méthode ne prend pas en charge plus de 10 demandes par seconde.