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. nom - 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":"ExampleAuthenticationCode" } }
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'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 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/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'ID de l'académie et l'ID 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 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/addParticipantWithoutNotifying" target="_blank" class="intercom-content-link">https://dashboard.easy-lms.com/?r=api/académie/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-academy/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. groupes - 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. 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 ne renverra pas dâerreur, mais mettra Ă jour les donnĂ©es du participant si lâidentifiant est le mĂȘme.