Passer au contenu principal

Appel d'API pour les formations

🩉 Documentation de l'API Easy LMS ✓ Formations ✓ Langage de l'API ✓ Ajouter un participant

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

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.

Avez-vous trouvé la réponse à votre question ?