Met onze eenvoudige API kun je automatisch deelnemers aan je cursussen toevoegen en hen een uitnodiging sturen.
API-taal
Onze API accepteert applicatie/x-www-form-urlencoded of multipart/form-data en json.
Cursus API
Deelnemer toevoegen
Deze API oproep is voor cursussen die alleen op uitnodiging worden gegeven.
HTTP-methode: POST
Eindpunt: https://dashboard-api.easy-lms.com/v1/course/{COURSE_ID}/add-participant
| Je moet de ID van de Cursus in de URL van het eindpunt invoeren in plaats van {COURSE_ID}. Je kunt dit ID vinden door naar Dashboard > Cursussen > Cursus > Integraties > API.
Kopteksten:
Inhoudstype: applicatie/json
X-Api-Key: API-sleutel geheim
Het API sleutelgeheim kan worden gegenereerd (of geregenereerd) door te gaan naar Mijn account > Geavanceerde setup > API toegang. Zorg ervoor dat je het API sleutelgeheim ergens veilig opslaat. Zodra je de pagina verlaat (of ververst) wordt deze NIET meer getoond om veiligheidsredenen!
Inhoud:
{
"Naam: "Deelnemer",
"e-mail": "participant@email.com"
}
| Vul gewoon de naam en het e-mailadres in van de deelnemer die je wilt toevoegen.
Succesvol antwoord:
{
"status": "ok",
"deelnemer": {
"Naam: "Deelnemer",
"e-mail": "participant@email.com",
"uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234"
}
}
Voorbeeld foutreactie:
{
"Naam: "Conflict",
"bericht": "Duplicaat invoer",
"code": 0,
"status": 409
}
Een deelnemer kan slechts één keer aan een cursus worden toegevoegd.
API-taal
Onze API accepteert applicatie/x-www-form-urlencoded of multipart/form-data en json.
Cursus API
Deelnemer toevoegen
Deze API oproep is voor cursussen die alleen op uitnodiging worden gegeven.
HTTP-methode: POST
Eindpunt: https://dashboard-api.easy-lms.com/v1/course/{COURSE_ID}/add-participant
| Je moet de ID van de Cursus in de URL van het eindpunt invoeren in plaats van {COURSE_ID}. Je kunt dit ID vinden door naar Dashboard > Cursussen > Cursus > Integraties > API.
Kopteksten:
Inhoudstype: applicatie/json
X-Api-Key: API-sleutel geheim
Het API sleutelgeheim kan worden gegenereerd (of geregenereerd) door te gaan naar Mijn account > Geavanceerde setup > API toegang. Zorg ervoor dat je het API sleutelgeheim ergens veilig opslaat. Zodra je de pagina verlaat (of ververst) wordt deze NIET meer getoond om veiligheidsredenen!
Inhoud:
{
"Naam: "Deelnemer",
"e-mail": "participant@email.com"
}
| Vul gewoon de naam en het e-mailadres in van de deelnemer die je wilt toevoegen.
Succesvol antwoord:
{
"status": "ok",
"deelnemer": {
"Naam: "Deelnemer",
"e-mail": "participant@email.com",
"uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234"
}
}
Voorbeeld foutreactie:
{
"Naam: "Conflict",
"bericht": "Duplicaat invoer",
"code": 0,
"status": 409
}
Een deelnemer kan slechts één keer aan een cursus worden toegevoegd.
Gepubliceerd op: 14 / 12 / 2020