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/{COURSE_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 ID en vous rendant dans 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 accĂ©dant Ă Mon compte > ParamĂštres avancĂ©s > AccĂšs Ă l'API. Veillez Ă conserver la clĂ© secrĂšte de l'API en lieu 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": "participant@email.com"}``` | 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": "participant@email.com", "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.