Met onze eenvoudige API kun je automatisch deelnemers aan je examens en academia toevoegen en ze een uitnodiging sturen.
API-taal
Onze API accepteert application/x-www-form-urlencoded of multipart/form-data en json.
Examen API
Deelnemer toevoegen
Deze API oproep werkt alleen als de toegang tot je examen is ingesteld op Een vooraf gedefinieerde groep gebruikers.
HTTP methode: POST
Eindpunt: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Succes antwoord
{Succes":true }
Foutmelding
{"succes":false,"error":"Voorbeeld fout" }
Veld - Type - Beschrijving
- String - De gegenereerde API-sleutel voor uw account. email - String - Het e-mailadres van de deelnemer die u wilt toevoegen. name - String - De naam van de deelnemer die u wilt toevoegen. examId - Integer - De ID van het Examen.
Deelnemer toevoegen zonder kennisgeving
Voeg een deelnemer toe aan je examen zonder hem een uitnodiging te sturen. De aanmeldingsgegevens worden in het antwoord teruggestuurd.
HTTP-methode: POST
Eindpunt: https: //dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
Succesvol antwoord
{"succes":true,"gegevens": {"playUrl":"[https://the.url/to/your/exam]([https://the.url/to/your/exam](https://the.url/to/your/exam))","email":"[[email protected]](mailto:[email protected])","authenticationCode":"ExampleAuthenticationCode" } }
Fout antwoord
{"success":false,"error":"Voorbeeld fout"}
- Type - Omschrijving apikey - String - De gegenereerde API key voor je account. email - String - Het e-mailadres van de deelnemer die je wilt toevoegen. name - String - De naam van de deelnemer die je wilt toevoegen. examId - Integer - De ID van het Examen. identifier - String - De identifier voor de deelnemer.
Akademia API
Deelnemer toevoegen
Deze API call voegt een deelnemer toe aan een Akademia en triggert dat de academie uitnodiging e-mail naar hem/haar wordt gestuurd. Je kunt deze API call ook gebruiken om de deelnemer meteen toe te voegen aan één of meerdere groepen.
De akademia ID en groep ID kunnen aan het einde van de URL staan:
In dit voorbeeld is de Akademia ID 123 en de Groep ID 45678.
Als er geen groeps-ID is opgegeven, wordt de deelnemer alleen toegevoegd aan de overzichtspagina voor deelnemers van de Akademia en de groep Iedereen. Als hij inlogt bij de Akademia, ziet hij alleen de groep Iedereen als daar inhoud aan is toegevoegd.
Als er geen Akademia ID is opgegeven, wordt de eerste Akademia gebruikt.
HTTP-methode: POST
Eindpunt: https: //dashboard.easy-lms.com/?r=api/academy/addParticipant
Succes antwoord
{"succes":true}
Foutmelding
{"succes":false,"error":"Voorbeeld fout"}
Veld - Type - Beschrijving
apikey - String - De gegenereerde API-sleutel voor je account. email - String - Het e-mailadres van de deelnemer die je wilt toevoegen. name - String - De naam van de deelnemer die je wilt toevoegen. groups - String - De ID's van de groepen waaraan je de deelnemer wilt toevoegen. Scheid ID's van groepen met een komma.academia - String - De ID van de academie waaraan u de deelnemer wilt toevoegen. Wordt standaard ingesteld op de eerste Akademia als er geen ID is opgegeven.
Deelnemer toevoegen zonder melding
Deze API call voegt een deelnemer toe aan je Akademia, maar stuurt geen uitnodiging. De uitnodigingslink wordt in de respons teruggestuurd. Je kunt deze API aanroep ook gebruiken om een deelnemer toe te voegen aan een of meer groepen in je akademia.
De Akademia ID en groep ID kunnen in de URL worden gevonden:
In dit voorbeeld is de academia ID 123 en de groep ID 45678.
Als er geen groeps-ID is opgegeven, wordt de deelnemer alleen toegevoegd aan de overzichtspagina voor deelnemers van de academie en de groep Iedereen. Als hij inlogt bij de Akademia, ziet hij alleen de groep Iedereen als daar inhoud aan is toegevoegd.
Als er geen Akademia ID is opgegeven, wordt de eerste Akademia gebruikt.
HTTP-methode: POST
Succesvol antwoord
`` {
"succes":true, "data":{"playUrl":"https://participant.easy-lms.com/your-academy","email":"[email protected]","inviteLink":"https://participant.easy-lms.com/your-academy/set-new-password?..."} }``
Fout antwoord
{"success":false,"error":"Voorbeeld fout" } }
Veld - Type - Beschrijving
- String - De gegenereerde API-sleutel voor uw account. email - String - Het e-mailadres van de deelnemer die u wilt toevoegen. name - String - De naam van de deelnemer die u wilt toevoegen. identifier - String - De identifier voor de deelnemer in uw systeem. groups - String - De ID's van de groepen waaraan u de deelnemer wilt toevoegen. Scheid ID's van groepen met een komma.academia - String - De ID van de academie waaraan u de deelnemer wilt toevoegen. Wordt standaard ingesteld op de eerste Akademia als er geen ID is opgegeven.
Als er al een deelnemer aan het examen of de academie is toegevoegd, zal de API niet falen, maar de deelnemersgegevens bijwerken als de identifier hetzelfde is.