Nous expliquons ici tout ce qui concerne (notre) API avec quelques exemples concrets, comment vous pouvez l'utiliser et pourquoi vous devriez l'utiliser.

API est l'abréviation d'Application Programming Interface (interface de programmation d'applications). Il s'agit de l'interface qui permet aux applications logicielles de communiquer entre elles. Basic vous permet de demander quelque chose, ou de poser une question, après quoi l'API effectue l'action qu'elle est censée faire, après que vous lui avez fourni des informations.

Imaginez que vous êtes assis à une table dans un restaurant et que vous avez le choix entre plusieurs menus. La cuisine est la partie du "système" qui prépare votre commande. Ce qui manque, c'est le lien essentiel qui permet de communiquer votre commande à la cuisine et de livrer votre repas à votre table. C'est là qu'intervient le serveur, ou API. Le serveur est le messager - ou API - qui reçoit votre demande ou votre commande et indique à la cuisine - au système - ce qu'il doit faire. Le serveur vous renvoie ensuite la réponse ; dans ce cas, il s'agit de la nourriture.

En résumé, lorsqu'une entreprise propose une API à ses clients, cela signifie simplement qu'elle a créé un ensemble d'URL dédiés qui renvoient des réponses sous forme de données pures - ce qui signifie que les réponses ne contiennent pas le type de présentation que l'on attendrait d'une interface utilisateur graphique telle qu'un site web.

Nous avons cinq appels API qui servent des fonctions différentes.

Un appel API se compose de trois éléments :

La charge utile est l'information envoyée à un point de terminaison, c'est-à-dire les données nécessaires pour ajouter un participant.

Le point de terminaison est une adresse web à laquelle les informations sont envoyées, et la réponse indique si l'appel à l'API a été couronné de succès ou non.

Leswebhooks peuvent être utilisés conjointement avec les appels API pour lancer différentes actions. Lorsqu'un webhook est envoyé et qu'il contient la charge utile requise pour qu'un certain appel d'API fonctionne, l'appel d'API fera son travail et ajoutera le participant. Les webhooks doivent être envoyés de votre système à notre point de terminaison et doivent être configurés par vous-même dans votre système.

Les paragraphes suivants font partie d'un cas d'utilisation fictif visant à expliquer comment les webhooks et les API peuvent fonctionner ensemble.

Un responsable des ressources humaines a créé une formation et un examen de niveau d'entrée pour les employés nouvellement embauchés. Il souhaite que les employés suivent la formation, mais qu'ils n'aient accès à l'examen qu'une fois la formation terminée. Ce n'est qu'après avoir réussi l'examen qu'il veut que les employés aient accès à l'académie, qui contient des formations et des examens de niveau intermédiaire et expert. Comment mettre cela en place ?

Pour comprendre comment mettre cela en place, nous avons déjà établi que ces webhooks et appels API seront envoyés en interne au sein du système Easy LMS. Le processus est le suivant.

Le responsable RH doit créer un webhook qui envoie un payload à l'API de l'examen une fois que l'employé a terminé la formation. Ce webhook doit uniquement contenir les données nécessaires pour déclencher l'appel à l'API d'examen. Dans ce cas, nous utilisons l'appel API Ajouter un participant à l'examen (invitation). Lorsque ce webhook a été envoyé, l'appel API est déclenché en cas de réponse positive. L'appel API ajoute le participant et envoie automatiquement l'invitation à l'examen.

Le deuxième webhook que le gestionnaire des ressources humaines doit créer concerne le cas où l'employé passe l'examen avec succès et obtient l'accès à l'académie. Là encore, la charge utile de ce webhook ne doit contenir que les informations dont l'appel à l'API de l'académie a besoin pour ajouter le participant et envoyer une invitation. Après avoir envoyé ce webhook, l'appel API de l'académie sera déclenché, après quoi il ajoutera le participant à l'académie et enverra une invitation.

En résumé :

Un client souhaite utiliser notre outil pour former ses (nouveaux) employés. Il utilise actuellement le paramètre Un groupe prédéfini de participants pour envoyer des courriels d'invitation. Cependant, de nombreux employés perçoivent ces invitations comme du spam, et certains de ces courriels se retrouvent également dans leurs dossiers de spam. Le client souhaite envoyer ces invitations à partir de son propre système.

Le client crée d'abord un webhook qui envoie une charge utile à l'API Examens - ajouter un participant sans le notifier. Lorsqu'un nouvel employé est ajouté à votre système, le webhook envoie la charge utile à l'API Examens qui ajoute l'employé. L'appel à l'API n'envoie pas d'invitation à cet employé. Lorsque l'appel à l'API aboutit, la réponse comprend les identifiants de connexion. Ces identifiants doivent ensuite être envoyés à l'employé à partir de votre propre système et de votre application de messagerie.

Cela fonctionne également pour les employés existants, il vous suffit de créer un webhook qui envoie une charge utile à l'API de l'examen qui déclenche l'action d'ajout de participants sans notification à l'examen. Les identifiants de connexion renvoyés dans la réponse à l'appel API peuvent alors être envoyés à partir de votre propre système.

Un client crée des examens dans notre système et les vend à ses propres clients à partir de son site web de commerce électronique. Il souhaite automatiser ce processus une fois que les clients ont payé pour un examen.

Pour automatiser le processus de vente, il devra utiliser un webhook. Lorsque les clients achètent ou paient un examen sur leur site web de commerce électronique, ils sont ajoutés à leur système. Le webhook qu'ils créent doit être déclenché après le paiement. Ce webhook enverra ensuite la charge utile pertinente à l'appel API de l'examen et doit renvoyer une réponse de succès ou d'erreur. S'il s'agit d'une réponse réussie, l'appel API ajoute et invite les clients à l'examen qu'ils ont payé.
​

Notre API accepte les formats application/x-www-form-urlencoded ou multipart/form-data et json.

Pour en savoir plus, consultez les articles suivants :