GrĂące Ă notre API simple d'utilisation, vous pouvez ajouter automatiquement des participants Ă vos formations et leur envoyer une invitation.
Langage de l'API
Notre API accepte les formats application/x-www-form-urlencoded, multipart/form-data et JSON.
API des formations
Ajouter un participant
Cet appel API concerne les formations accessibles uniquement sur invitation.
Méthode HTTP : POST
Point de terminaison : https://dashboard-api.easy-lms.com/v1/course/%7BCOURSE_ID%7D/add-participant" target="_blank" class="intercom-content-link">https://dashboard-api.easy-lms.com/v1/formation/{FORMATION_ID}/add-participant
Vous devez saisir lâID de la formation dans lâURL du point de terminaison Ă la place de {COURSE_ID}. Vous pouvez trouver cet identifiant en vous rendant sur Tableau de bord > Formations > Formation > IntĂ©grations > API.
En-tĂȘtes :
: application/jsonX-Api-Key : clĂ© secrĂšte de lâAPI
La clĂ© secrĂšte de lâAPI peut ĂȘtre gĂ©nĂ©rĂ©e (ou rĂ©gĂ©nĂ©rĂ©e) en vous rendant sur Mon compte > ParamĂštres avancĂ©s > AccĂšs Ă lâAPI. Veillez Ă enregistrer la clĂ© secrĂšte de lâAPI dans un endroit sĂ»r. Une fois que vous aurez quittĂ© (ou actualisĂ©) la page, elle ne sâaffichera PLUS pour des raisons de sĂ©curitĂ© !
Contenu :
{ "name": "Participant", "email": "[email protected]"}``` | Il suffit de saisir le nom et lâadresse e-mail du participant que vous souhaitez ajouter. **RĂ©ponse de rĂ©ussite :** ```{ "status": "ok", "participant": { "name": "Participant", "email": "[email protected]", "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234" }}
Exemple de réponse d'erreur :
{ "name": "Conflict", "message": "EntrĂ©e en double", "code": 0, "status": 409}Si un participant a dĂ©jĂ Ă©tĂ© ajoutĂ© Ă une formation, lâAPI ne renverra pas dâerreur, mais mettra Ă jour les donnĂ©es du participant si lâidentifiant est identique.
