Nous vous expliquons ici tout ce qu'il faut savoir sur (notre) API à l'aide d'exemples concrets : comment l'utiliser et pourquoi vous devriez l'utiliser.

API est l'acronyme de « Application Programming Interface » (interface de programmation d'application). Il s'agit de l'interface qui permet aux applications logicielles de communiquer entre elles. Concrètement, elle vous permet d'effectuer une requête ou de poser une question ; l'API exécute alors l'action prévue, une fois que vous lui avez fourni les informations nécessaires.

Imaginez que vous soyez assis à une table dans un restaurant, avec un menu proposant plusieurs choix. La cuisine est la partie du « système » qui va préparer votre commande. Il manque toutefois le maillon essentiel pour transmettre votre commande à la cuisine et vous servir votre plat à table. C’est là qu’intervient le serveur, ou l’API. Le serveur est le messager – ou l’API – qui prend votre demande ou votre commande et indique à la cuisine – le système – ce qu’elle doit faire. Ensuite, le serveur vous remet la réponse ; dans ce cas, il s’agit du repas.

En résumé, lorsqu’une entreprise propose une API à ses clients, cela signifie simplement qu’elle a créé un ensemble d’URL dédiées qui renvoient des réponses sous forme de données brutes — c’est-à-dire que ces réponses ne contiennent pas les éléments de présentation superflus que l’on trouve habituellement dans une interface utilisateur graphique telle qu’un site web.

Nous proposons cinq appels API qui remplissent différentes fonctions.

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

La charge utile correspond aux informations envoyées à un point de terminaison, c'est-à-dire aux données nécessaires pour ajouter un participant.

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

Les webhooks peuvent être utilisés en association avec des appels API pour déclencher différentes actions. Lorsqu’un webhook contenant la charge utile requise pour qu’un appel API spécifique fonctionne est envoyé, l’appel API effectue son opération et ajoute le participant. Les webhooks doivent être envoyés depuis votre système vers notre point de terminaison et doivent être configurés par vos soins dans votre système.

Les paragraphes suivants s’inscrivent dans le cadre d’un cas d’utilisation fictif visant à expliquer comment les webhooks et les API peuvent fonctionner ensemble.

Un responsable RH a créé une formation d’initiation et un examen destinés aux nouveaux employés. Le responsable RH souhaite que les employés suivent la formation, mais ne veut leur donner accès à l’examen qu’après avoir terminé celle-ci. Ce n’est qu’après avoir réussi l’examen qu’il souhaite que les employés aient accès à l’académie, qui contient des formations et des examens de niveau intermédiaire et expert. Alors, comment mettre cela en place ?

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

Le responsable des ressources humaines doit créer un webhook qui envoie une charge utile à l’API d’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 de l’API d’examen. Dans ce cas, nous utilisons l’appel API « Ajouter un participant à un examen (invitation) ». Une fois ce webhook envoyé, l’appel API sera déclenché si la réponse est positive. L’appel API ajoute le participant et envoie automatiquement l’invitation à l’examen.

Le deuxième webhook que le responsable RH doit créer intervient lorsque l’employé réussit l’examen et obtient ainsi l’accès à l’académie. Là encore, la charge utile de ce webhook ne doit contenir que les informations dont l’appel API de l’académie a besoin pour ajouter le participant et envoyer une invitation. Après l’envoi de ce webhook, l’appel API de l’académie sera déclenché, puis 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 « Groupe prédéfini de participants » pour envoyer des e-mails d’invitation. Cependant, de nombreux employés perçoivent ces invitations comme du spam, et certains de ces e-mails finissent également dans leur dossier de spam. Le client souhaite donc envoyer ces invitations depuis son propre système.

Le client crée d’abord un webhook qui envoie une charge utile à l’API « Examen » – « Ajouter un participant » sans notification. Lorsqu’un nouvel employé est ajouté à votre système, le webhook envoie la charge utile à l’API « Examen » qui ajoute l’employé. L’appel API n’envoie pas d’invitation à cet employé. Lorsque l’appel API aboutit, la réponse inclut les identifiants de connexion. Ces identifiants doivent ensuite être envoyés à l’employé depuis votre propre système et 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 « Examen » et déclenche l’action d’ajout de participants sans notification à l’examen. Les identifiants de connexion renvoyés dans la réponse de l’appel API peuvent ensuite être envoyés depuis votre propre système.

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

Pour automatiser le processus de vente, il devra utiliser un webhook. Lorsque ses clients achètent ou paient un examen sur son site e-commerce, ils sont ajoutés à son système. Le webhook qu’il crée doit être déclenché une fois le paiement effectué. Ce webhook enverra alors la charge utile correspondante à l’appel de l’API d’examen et devra renvoyer soit une réponse de réussite, soit une réponse d’erreur. En cas de réponse de réussite, l’appel de l’API ajoute les clients à l’examen qu’ils ont payé et les y invite.
​

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

Pour en savoir plus, consultez les articles suivants :