Cet article est aussi disponible en :
Grâce à notre API simple, vous pouvez ajouter automatiquement des participants à vos cours et leur envoyer une invitation.

Langage API

Notre API accepte les données de type application/x-www-form-urlencoded ou multipart/form-data et json.

Cours API

Ajouter un participant

Cet appel API concerne les cours sur invitation uniquement.

Méthode HTTP : POST

Endpoint : https://dashboard-api.easy-lms.com/v1/course/{COURSE_ID}/add-participant

Vous devez entrer l'ID du cours dans l'URL du point final à la place de {COURSE_ID}. Vous pouvez trouver cet ID en allant sur Dashboard > Courses > Course > Integrations > API.

En-têtes :

Type de contenu : application/json
X-Api-Key : secret de la clé API


Le secret de la clé API peut être généré (ou régénéré) en allant sur Mon compte > Configuration avancée > Accès API. Assurez-vous de sauvegarder la clé secrète de l'API dans un endroit sûr. Une fois que vous aurez quitté (ou régénéré) la page, elle ne sera plus affichée pour des raisons de sécurité !

Contenu :

{
"nom" : "Participant",
"email" : "participant@email.com"
}


Il suffit d'entrer le nom et l'adresse électronique du participant que vous souhaitez ajouter.

Réaction positive :

{
"statut" : "ok",
"participant" : {
"nom" : "Participant",
"email" : "participant@email.com",
"uuid" : "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234"
}
}


Exemple de réponse d'erreur :

{
"nom" : "conflit",
"message" : "Dédoublement",
"code" : 0,
"statut" : 409
}


Un participant ne peut être ajouté qu'une seule fois à chaque cours.
Cet article a-t-il répondu à vos questions ?
Annuler
Merci !