Cet article est aussi disponible en :
Nous vous expliquons ici tout ce qui concerne (notre) API avec quelques exemples intéressants, comment vous pouvez l'utiliser et pourquoi vous devriez l'utiliser.

1. Qu'est-ce que l'API ?

API signifie Application Programming Interface. Il s'agit de l'interface qui permet aux applications logicielles de communiquer entre elles. Elle vous permet essentiellement de demander quelque chose, ou de poser une question, après quoi l'appel API effectue l'action qu'il est censé faire, après que vous lui ayez fourni des informations. Dans notre cas, il s'agit de demander l'ajout d'un participant à un examen, à un cours ou à l'Académie, ce qui nécessite des données spécifiques sur le participant.

Exemple 1

Lorsque vous allez sur Facebook dans votre navigateur, une requête est envoyée au serveur distant de Facebook. Une fois que votre navigateur reçoit la réponse, il interprète le code et affiche la page.

Pour le navigateur, également appelé client, le serveur de Facebook est une API. Cela signifie que chaque fois que vous visitez une page sur le Web, vous interagissez avec l'API d'un serveur distant.

Une API n'est pas la même chose qu'un serveur distant - rather server  c'est la partie du serveur qui reçoit les requêtes et envoie les réponses.

Exemple 2

Imaginez que vous êtes assis à une table dans un restaurant avec un menu de choix à commander. La cuisine est la partie du "système" qui préparera votre commande. Ce qui manque, c'est le lien essentiel qui permet de communiquer votre commande à la cuisine et de livrer votre nourriture à votre 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'il faut faire. Ensuite, le serveur vous livre la réponse ; dans ce cas, il s'agit de la nourriture.

Pour résumer, lorsqu'une entreprise propose une API à ses clients, cela signifie simplement qu'elle a construit un ensemble d'URL dédiées qui renvoient des données pures responses - meaning les réponses ne contiendront pas le type de surcharge de présentation que l'on peut attendre d'une interface utilisateur graphique comme un site web.

2. À quoi sert-il ?

Les développeurs peuvent utiliser différentes API de différentes manières pour construire différentes choses. Facebook en est un bon exemple ; le site a lancé sa plateforme de développement appelée F8 en mai et héberge maintenant un nombre étonnant de 10 900 applications allant du tristement célèbre Scrabulous à la messagerie instantanée en passant par les jeux de combat de nourriture.

L'avantage pour le site hôte est qu'il bénéficie gratuitement de nombreuses nouvelles fonctionnalités intéressantes, tandis que les développeurs peuvent promouvoir leur travail sur un site plus visible et s'appuyer sur le travail de quelqu'un d'autre. La plupart de ces applications sont créées par des entreprises ayant leur propre site web, souvent des petites entreprises à faible trafic qui bénéficient de ce croisement. Le site de critique de films Flixster, par exemple, possède une application Facebook très populaire, tout comme Last.fm et le site de partage de photos Flickr.

3. Quels sont les appels API d'Easy LMS ?

Easy LMS dispose de cinq appels API qui remplissent différentes fonctions :

Ajouter un participant à l'examen (inviter)
Ajouter un participant à Examiner sans le notifier (pas d'invitation)
Ajouter un participant au cours (inviter)
Ajouter un participant à Academy (inviter)
Ajouter un participant à Academy sans le notifier (pas d'invitation)

L'API prévoit qu'un examen ne fonctionne que lorsque l'accès est défini sur . Un groupe prédéfini de participants, ou pour un cours qui est uniquement sur invitation. Ceci est évident pour l'Académie. Il n'est pas non plus possible d'utiliser l'un de ces appels pour le même examen, le même cours ou la même académie lorsqu'un participant y a déjà été ajouté. En effet, le but de ces appels API est d'ajouter des participants, donc s'ils ont déjà été ajoutés, l'appel API ne fonctionne pas.

Un appel API se compose de trois choses :

La charge utile (les données réelles qui sont envoyées)
Le point final (l'adresse à laquelle les données sont envoyées)
La réponse (succès ou erreur de réponse)

La charge utile est l'information qui est envoyée à un point final, ce qui signifie que des données sont nécessaires pour ajouter un participant à l'examen, au cours ou à l'académie.

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

4. Webhooks

Les webhooks peuvent être utilisés en conjonction avec les appels API pour lancer différentes actions. Lorsqu'un webhook contenant la charge utile nécessaire pour qu'un certain appel API fonctionne est envoyé, l'appel API fait son travail et ajoute le participant. Les webhooks doivent être envoyés de votre système vers notre terminal. C'est quelque chose que vous devez paramétrer vous-même dans votre système.

Exemple 1 - Cours, examen, académie

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

Un responsable des ressources humaines a créé un cours et un examen de niveau débutant pour les employés nouvellement embauchés. Le responsable des ressources humaines souhaite que les employés suivent le cours, mais qu'ils n'aient accès à l'examen qu'après avoir terminé le cours. 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 cours et des examens de niveau intermédiaire et expert. Alors, comment mettre en place tout cela ?

Pour comprendre comment mettre en place ce système, nous avons déjà établi que ces webhooks et appels API seront envoyés en interne dans le 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é le cours. Ce webhook ne doit contenir que les données nécessaires pour déclencher l'appel à l'API d'examen. Dans ce cas, nous utilisons l'appel API Add participant to Exam (invite). Une fois que ce webhook a été envoyé, l'appel API sera déclenché en cas de réponse positive. L'appel API ajoute le participant et envoie automatiquement l'invitation à l'examen.

Le deuxième crochet web que le responsable des ressources humaines doit créer est destiné à l'accès à l'Académie lorsque l'employé réussit l'examen. 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 "Examen réussi", l'appel API de l'Académie sera déclenché, après quoi il ajoute le participant et envoie une invitation pour l'Académie.

Pour résumer :

Créer un webhook pour l'achèvement du cours qui est envoyé à l'appel API de l'examen.
Créer un webhook pour la réussite de l'examen qui est envoyé à l'appel API de l'Académie.
L'employé suit le cours et le termine.
Le webhook pour terminer le cours est envoyé à Ajouter un participant à l'examen (inviter) Appel API et ajoute et invite le participant à l'examen.
L'employé passe l'examen et le réussit.
Le crochet Web pour la réussite de l'examen est envoyé à Ajouter un participant à l'Académie (inviter) API call endpoint et ajoute et invite le participant à l'Académie.



Exemple 2 - Envoi d'invitations à partir de votre propre système

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 e-mails finissent également dans leurs dossiers de spam. Le client souhaite plutôt envoyer ces invitations à partir de son propre système.

Le client crée d'abord un webhook qui envoie une charge utile à l'API d'examen - ajouter un participant sans en avertir. Lorsqu'un nouvel employé est ajouté à votre système, le webhook envoie la charge utile à l'API d'examen qui ajoute l'employé. L'appel de l'API n'envoie pas d'invitation à cet employé. Lorsque l'appel API est réussi, 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 suffit de créer un webhook qui envoie une charge utile à l'API de l'examen qui déclenche l'action d'ajouter des participants sans en avertir l'examen. Les identifiants de connexion renvoyés dans la réponse à l'appel de l'API peuvent ensuite être envoyés depuis votre propre système.

Exemple 3 - Vente d'examens

Un client crée des examens dans notre système et les vend à ses propres clients à partir de leur site de commerce électronique. Il veut automatiser cette opération après que ses clients aient payé pour un examen.

Pour automatiser son processus de vente, il devra utiliser un webhook. Lorsque ses clients achètent ou paient un examen sur son site de commerce électronique, ils sont ajoutés à son système. Le webhook qu'il crée doit être déclenché après qu'ils ont payé. Ce webhook enverra alors la charge utile correspondante à l'appel de l'API d'examen et doit renvoyer une réponse de succès ou d'erreur. Si la réponse est positive, l'appel API ajoute et invite ses clients à l'examen pour lequel ils ont payé.



5. Quand utilisons-nous chacun des appels API et quelles sont leurs spécifications ?

Comme chaque appel API a une fonction différente, ils peuvent être utilisés pour réaliser différentes choses. Par exemple, Add participant to Exam (invite) peut être utilisé pour ajouter un participant et envoyer une invitation à un examen automatiquement lorsque ce déclencheur est activé.

Notre API accepte les données de type application/x-www-form-urlencoded ou multipart/form-data et json.

Pour en savoir plus sur nos appels d'offres pour l'examen et l'API de l'Académie, consultez cet article.

Pour en savoir plus sur notre appel API de cours, consultez cet article.
Cet article a-t-il répondu à vos questions ?
Annuler
Merci !