Met onze eenvoudige API kun je automatisch deelnemers aan je cursussen toevoegen en hen een uitnodiging sturen.
API-taal
Onze API accepteert application/x-www-form-urlencoded, multipart/form-data en JSON.
Cursus-API
Deelnemer toevoegen
Deze API-aanroep is bedoeld voor cursussen die alleen op uitnodiging toegankelijk zijn.
HTTP-methode: POST
Eindpunt:https://dashboard-api.easy-lms.com/v1/course/%7BCOURSE_ID%7D/add-participanteasy-lms.com/v1/cursus/{CURSUS_ID}/add-participant
U moet de ID van de cursus invoeren in de eindpunt-URL in plaats van {COURSE_ID}. U kunt deze ID vinden door naar Dashboard > Cursussen > Cursus > Integraties > API te gaan.
Headers:
: application/jsonX-Api-Key: API-sleutelgeheim
Het API-sleutelgeheim kan worden gegenereerd (of opnieuw worden gegenereerd) door naar Mijn account > Advanced instellingen > API-toegang te gaan. Zorg ervoor dat je het API-sleutelgeheim op een veilige plek bewaart. Zodra je de pagina verlaat (of vernieuwt), wordt deze om veiligheidsredenen NIET meer weergegeven!
Inhoud:
{ "name": "Deelnemer", "email": "participant@email.com"}``` | Voer gewoon de naam en het e-mailadres in van de deelnemer die je wilt toevoegen. **Succesbericht:** ```{ "status": "ok", "participant": { "name": "Participant", "email": "participant@email.com", "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234" }}
Voorbeeld van een foutmelding:
{ "name": "Conflict", "message": "Dubbele invoer", "code": 0, "status": 409}Als een deelnemer al aan een cursus is toegevoegd, zal de API niet mislukken, maar de deelnemersgegevens bijwerken als de identificatiecode hetzelfde is.