Grùce à notre API simple d'utilisation, vous pouvez ajouter automatiquement des participants à votre examen et à votre académie, puis leur envoyer une invitation.
Langage de l'API
Notre API accepte les formats application/x-www-form-urlencoded, multipart/form-data et JSON.
API d'examen
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 réussite
{ "success":true }Â
RĂ©ponse d'erreur
{ "success":false, "error":"Exemple d'erreur" }Â
Champ - Type - Description
- ChaĂźne de caractĂšres - La clĂ© API gĂ©nĂ©rĂ©e pour votre compte. email - ChaĂźne de caractĂšres - L'adresse e-mail du participant que vous souhaitez ajouter. name - ChaĂźne de caractĂšres - Le nom du participant que vous souhaitez ajouter. examId - Entier - L'identifiant de l'Examen.Â
Ajouter un participant sans l'en informer
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 réussite
{ "success":true, "data": Â Â { "playUrl":"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))", Â Â Â Â Â Â "email":"[john@doe.com](mailto:john@doe.com)", "authenticationCode":"ExempleDeCodeD'authentification" } }Â
RĂ©ponse d'erreur
{ "success":false, "error":"Exemple d'erreur"}Â
- Type - Description apikey - ChaĂźne de caractĂšres - La clĂ© API gĂ©nĂ©rĂ©e pour votre compte. email - ChaĂźne de caractĂšres - L'adresse e-mail du participant que vous souhaitez ajouter. name - ChaĂźne de caractĂšres - Le nom du participant que vous souhaitez ajouter. examId - Entier - L'identifiant de l'examen. identifier - ChaĂźne de caractĂšres - L'identifiant du participant.Â
API Académie
Ajouter un participant
Cet appel API ajoute un participant à une académie et déclenche l'envoi de l'e-mail d'invitation à l'académie. Vous pouvez également utiliser cet appel API pour ajouter immédiatement le participant à un ou plusieurs groupes.
L'ID de l'académie et l'ID du groupe se trouvent à la fin de l'URL :
Dans cet exemple, lâID de lâacadĂ©mie est 123 et lâID du groupe est 45678.
Si aucun identifiant de groupe nâest spĂ©cifiĂ©, le participant est uniquement ajoutĂ© Ă la page « Aperçu des participants » de lâacadĂ©mie et au 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/académie/addParticipant
Réponse de réussite
{ "success":true}Â
RĂ©ponse d'erreur
{ "success":false, "error":"Exemple d'erreur"}
Champ - Type - Description
apikey - Chaßne de caractÚres - La clé API générée pour votre compte. email - Chaßne de caractÚres - L'adresse e-mail du participant que vous souhaitez ajouter. name - Chaßne de caractÚres - Le nom du participant que vous souhaitez ajouter. groups - Chaßne de caractÚres - Les identifiants des groupes auxquels vous souhaitez ajouter le participant. Séparez les identifiants de groupe par une virgule.academy - Chaßne de caractÚres - L'identifiant de l'académie à laquelle vous souhaitez ajouter le participant. La valeur par défaut est la premiÚre académie si aucun identifiant n'est fourni.
Ajouter un participant sans notification
Cet appel 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 API pour ajouter un participant à un ou plusieurs groupes de votre académie.
Lâidentifiant de lâacadĂ©mie et lâidentifiant du groupe figurent dans lâURL :
Dans cet exemple, lâID de lâacadĂ©mie est 123 et lâID du groupe est 45678.
Si aucun identifiant de groupe nâest spĂ©cifiĂ©, le participant est uniquement ajoutĂ© Ă la page « Aperçu des participants » de lâacadĂ©mie et au 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 réussite
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"john@doe.com", "inviteLink":"https://participant.easy-lms.com/your-académie/set-new-password?..." } }``
RĂ©ponse d'erreur
{ "success":false, "error":"Exemple d'erreur" }
Champ - Type - Description
- ChaĂźne de caractĂšres - La clĂ© API gĂ©nĂ©rĂ©e pour votre compte. email - ChaĂźne de caractĂšres - L'adresse e-mail du participant que vous souhaitez ajouter. name - ChaĂźne de caractĂšres - Le nom du participant que vous souhaitez ajouter. identifier - ChaĂźne de caractĂšres - L'identifiant du participant dans votre systĂšme. groups - ChaĂźne de caractĂšres - Les identifiants des groupes auxquels vous souhaitez ajouter le participant. SĂ©parez les identifiants de groupe par une virgule.acadĂ©mie - ChaĂźne de caractĂšres - Lâidentifiant de lâacadĂ©mie Ă laquelle vous souhaitez ajouter le participant. La valeur par dĂ©faut est 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 ne renverra pas dâerreur, mais mettra Ă jour les donnĂ©es du participant si lâidentifiant est identique.