Grùce à notre API simple, vous pouvez ajouter automatiquement des participants à votre examen et à votre académie et leur envoyer une invitation.
Langage de l'API
Notre API accepte les formats application/x-www-form-urlencoded ou multipart/form-data et json.
API des examens
Ajouter un participant
Cet appel API ne fonctionne que si l'accÚs à votre examen est défini sur Un groupe d'utilisateurs prédéfini.
MĂ©thode HTTP : POST
Point de terminaison : https://dashboard.easy-lms.com/?r=api/exam/addParticipant
RĂ©ponse de succĂšs
{ "success":true }
RĂ©ponse d'erreur
{ "success":false, "error" : "Example error" }
Champ - Type - Description
- String - La clé API générée pour votre compte. email - String - L'adresse email du participant que vous souhaitez ajouter. name - String - Le nom du participant que vous souhaitez ajouter. examId - Integer - L'ID de l'Examen.
Ajouter un participant sans le notifier
Ajoutez un participant à votre examen sans lui envoyer d'invitation. Les identifiants de connexion seront renvoyés dans la réponse.
MĂ©thode HTTP : POST
Point de terminaison : https://dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
RĂ©ponse de succĂšs
{"success":true, "data" : {"playUrl" :"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))", "email" :"[[email protected]](mailto:[email protected])", "authenticationCode" : "ExampleAuthenticationCode" } }
RĂ©ponse d'erreur
{ "success":false, "error" : "Example error"}
- Type - Description apikey - String - La clé API générée pour votre compte. email - String - L'adresse email du participant que vous souhaitez ajouter. name - String - Le nom du participant que vous souhaitez ajouter. examId - Integer - L'ID de l'Examen. identifier - String - L'identifiant du participant.
API Académie
Ajouter un participant
Cet appel API ajoute un participant à une académie et déclenche l'envoi du courrier électronique d'invitation à l'académie. Vous pouvez également utiliser cet appel API pour ajouter immédiatement le participant à un ou plusieurs groupes.
L'identifiant de l'académie et l'identifiant du groupe se trouvent à la fin de l'URL :
Dans cet exemple, l'identifiant de l'académie est 123, et l'identifiant du groupe est 45678.
Si aucun ID de groupe n'est spécifié, le participant n'est ajouté qu'à la page d'aperçu des participants de l'académie et du groupe Tout le monde. Lorsqu'il se connectera à l'académie, il ne verra le groupe Tout le monde que si du contenu y a été ajouté.
Si aucun identifiant d'académie n'est fourni, la premiÚre académie sera utilisée.
MĂ©thode HTTP : POST
Point de terminaison : https://dashboard.easy-lms.com/?r=api/academy/addParticipant
RĂ©ponse de succĂšs
{"success":true}
RĂ©ponse d'erreur
{ "success":false, "error" : "Example error"}
Champ - Type - Description
apikey - Chaßne - La clé API générée pour votre compte. email - Chaßne - L'adresse email du participant que vous souhaitez ajouter. name - Chaßne - Le nom du participant que vous souhaitez ajouter. groups - Chaßne - Les ID des groupes auxquels vous souhaitez ajouter le participant. Séparer les identifiants des groupes par une virgule.academy - Chaßne - L'identifiant de l'académie à laquelle vous souhaitez ajouter le participant. Par défaut, il s'agit de la premiÚre académie si aucun identifiant n'est fourni.
Ajouter un participant sans le notifier
Cet appel d'API ajoute un participant à votre académie, mais n'envoie pas d'invitation. Le lien d'invitation sera renvoyé dans la réponse. Vous pouvez également utiliser cet appel d'API pour ajouter un participant à un ou plusieurs groupes de votre académie.
L'identifiant de l'académie et l'identifiant du groupe se trouvent dans l'URL :
Dans cet exemple, l'identifiant de l'académie est 123, et l'identifiant du groupe est 45678.
Si aucun ID de groupe n'est spécifié, le participant est uniquement ajouté à la page d'aperçu des participants de l'académie et du groupe Tout le monde. Lorsqu'il se connectera à l'académie, il ne verra le groupe Tout le monde que si du contenu y a été ajouté.
Si aucun identifiant d'académie n'est fourni, la premiÚre académie sera utilisée.
MĂ©thode HTTP : POST
Point de terminaison : https://dashboard.easy-lms.com/?r=api/academy/addParticipantWithoutNotifying
RĂ©ponse de succĂšs
`` {
"success":true, "data":{"playUrl" :"https://participant.easy-lms.com/your-academy", "email" :"[email protected]", "inviteLink" :"https://participant.easy-lms.com/your-academy/set-new-password ?..."} }``
RĂ©ponse d'erreur
{ "success":false, "error" : "Example error" }
Champ - Type - Description
- String - La clé API générée pour votre compte. email - String - L'adresse email du participant que vous souhaitez ajouter. name - String - Le nom du participant que vous souhaitez ajouter. identifier - String - L'identifiant du participant dans votre systÚme. groups - String - Les ID des groupes auxquels vous souhaitez ajouter le participant. Séparer les ID des groupes par une virgule.academy - Chaßne - L'ID de l'académie à laquelle vous souhaitez ajouter le participant. Par défaut, il s'agit de la premiÚre académie si aucun identifiant n'est fourni.
Si un participant a dĂ©jĂ Ă©tĂ© ajoutĂ© Ă l'examen ou Ă l'acadĂ©mie, l'API n'Ă©chouera pas, mais elle mettra Ă jour les donnĂ©es du participant si l'identifiant est le mĂȘme.