Met onze eenvoudige API kun je automatisch deelnemers toevoegen aan je examen en academie en hen een uitnodiging sturen.
API-taal
Onze API accepteert application/x-www-form-urlencoded, multipart/form-data en JSON.
Examen-API
Deelnemer toevoegen
Deze API-aanroep werkt alleen als de toegang tot uw examen is ingesteld op 'Een vooraf gedefinieerde groep gebruikers'.
HTTP-methode: POST
Succesreactie
{ "success":true }
Foutmelding
{ "success":false, "error":"Voorbeeldfout" }
Veld - Type - Beschrijving
- Tekst - De gegenereerde API-sleutel voor uw account. e-mail - Tekst - Het e-mailadres van de deelnemer die u wilt toevoegen. naam - Tekst - De naam van de deelnemer die u wilt toevoegen. examId - Geheel getal - Het ID van het Examen.
Deelnemer toevoegen zonder kennisgeving
Voeg een deelnemer toe aan uw examen zonder hem of haar een uitnodiging te sturen. De inloggegevens worden in het antwoord teruggestuurd.
HTTP-methode: POST
Succesantwoord
{ "success":true, "data": { "playUrl":"[https://the.url/to/your/examen]([https://the.url/to/your/examen](https://the.url/to/your/examen))", "email":"[[email protected]](mailto:[email protected])", "authenticationCode":"VoorbeeldAuthenticatiecode" } }
Foutmelding
{ "success":false, "error":"Voorbeeldfout"}
- Type - Beschrijving apikey - Tekst - De gegenereerde API-sleutel voor uw account. email - Tekst - Het e-mailadres van de deelnemer die u wilt toevoegen. name - Tekst - De naam van de deelnemer die u wilt toevoegen. examId - Geheel getal - Het ID van het examen. identifier - Tekst - De identificatiecode van de deelnemer.
Academie API
Deelnemer toevoegen
Deze API-aanroep voegt een deelnemer toe aan een academie en zorgt ervoor dat de uitnodigingsmail voor de academie naar hem of haar wordt verzonden. U kunt deze API-aanroep ook gebruiken om de deelnemer direct aan een of meer groepen toe te voegen.
De academie-ID en groeps-ID staan aan het einde van de URL:
In dit voorbeeld is de academie-ID 123 en de groeps-ID 45678.
Als er geen groeps-ID is opgegeven, wordt de deelnemer alleen toegevoegd aan de pagina ‘Deelnemersoverzicht’ van de academie en aan de groep ‘Iedereen ’. Wanneer de deelnemer inlogt bij de academie, ziet hij of zij alleen de groep ‘Iedereen ’ als er inhoud aan is toegevoegd.
Als er geen academie-ID wordt opgegeven, wordt de eerste academie gebruikt.
HTTP-methode: POST
Succesreactie
{ "success":true}
Foutmelding
{ "success":false, "error":"Voorbeeldfout"}
Veld - Type - Beschrijving
apikey - Tekst - De gegenereerde API-sleutel voor uw account. email - Tekst - Het e-mailadres van de deelnemer die u wilt toevoegen. name - Tekst - De naam van de deelnemer die u wilt toevoegen. groups - Tekst - De ID's van de groepen waaraan u de deelnemer wilt toevoegen. Scheid groeps-ID's met een komma. academy - Tekst - De ID van de academie waaraan u de deelnemer wilt toevoegen. Standaard is dit de eerste academie als er geen ID wordt opgegeven.
Deelnemer toevoegen zonder kennisgeving
Deze API-aanroep voegt een deelnemer toe aan je academie, maar verstuurt geen uitnodiging. De uitnodigingslink wordt in het antwoord teruggestuurd. Je kunt deze API-aanroep ook gebruiken om een deelnemer toe te voegen aan een of meer groepen in je academie.
De academie-ID en groeps-ID zijn te vinden in de URL:
In dit voorbeeld is de academie-ID 123 en de groeps-ID 45678.
Als er geen groeps-ID is opgegeven, wordt de deelnemer alleen toegevoegd aan de pagina Deelnemersoverzicht van de academie en aan de groep Iedereen. Wanneer de deelnemer inlogt op de academie, ziet hij of zij alleen de groep Iedereen als er inhoud aan is toegevoegd.
Als er geen academie-ID wordt opgegeven, wordt de eerste academie gebruikt.
HTTP-methode: POST
Succesreactie
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"[email protected]", "inviteLink":"https://participant.easy-lms.com/your-academie/set-new-password?..." } }``
Foutmelding
{ "success":false, "error":"Voorbeeldfout" }
Veld - Type - Beschrijving
- Tekststring - De gegenereerde API-sleutel voor uw account. email - Tekststring - Het e-mailadres van de deelnemer die u wilt toevoegen. name - Tekststring - De naam van de deelnemer die u wilt toevoegen. identifier - Tekststring - De identificatiecode van de deelnemer in uw systeem. groepen - Tekst - De ID's van de groepen waaraan u de deelnemer wilt toevoegen. Scheid de groeps-ID's met een komma.academie - Tekst - De ID van de academie waaraan u de deelnemer wilt toevoegen. Standaard is dit de eerste academie als er geen ID wordt opgegeven.
Als een deelnemer al aan het examen of de academie is toegevoegd, zal de API niet mislukken, maar worden de gegevens van de deelnemer bijgewerkt als de identificatiecode hetzelfde is.