Mit unserer einfachen API können Sie automatisch Teilnehmer zu Ihrer Prüfung und Academy hinzufügen und ihnen eine Einladung schicken.
API-Sprache
Unsere API akzeptiert application/x-www-form-urlencoded oder multipart/form-data und json.
Prüfung API
Teilnehmer hinzufügen
Dieser API-Aufruf funktioniert nur, wenn der Zugang zu Ihrer Prüfung auf eine vordefinierte Benutzergruppe eingestellt ist.
HTTP-Methode: POST
Endpunkt: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Erfolgsmeldung
{ "Erfolg":true }
Fehler-Antwort
{ "success":false, "error": "Beispielfehler" }
Feld - Typ - Beschreibung
- String - Der generierte API-Schlüssel für Ihr Konto. email - String - Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name - String - Der Name des Teilnehmers, den Sie hinzufügen möchten. examId - Integer - Die ID der Prüfung.
Teilnehmer ohne Benachrichtigung hinzufügen
Fügen Sie einen Teilnehmer zu Ihrer Prüfung hinzu, ohne ihm eine Einladung zu schicken. Die Anmeldedaten werden in der Antwort zurückgegeben.
HTTP-Methode: POST
Endpunkt: https: //dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
Antwort bei Erfolg
{ "success":true, "data": { "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" } }
Fehlerantwort
{ "success":false, "error": "Beispielfehler"}
- Typ - Beschreibung apikey - String - Der generierte API-Schlüssel für Ihr Konto. email - String - Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name - String - Der Name des Teilnehmers, den Sie hinzufügen möchten. examId - Integer - Die ID der Prüfung. identifier - String - Die Kennung für den Teilnehmer.
Academy API
Teilnehmer hinzufügen
Dieser API-Aufruf fügt einen Teilnehmer zu einer Academy hinzu und veranlasst, dass die Academy-Einladungs-E-Mail an ihn gesendet wird. Sie können diesen API-Aufruf auch verwenden, um den Teilnehmer sofort zu einer oder mehreren Gruppen hinzuzufügen.
Die ID der Academy und die Gruppen-ID können am Ende der URL angegeben werden:
In diesem Beispiel lautet die academy ID 123 und die group ID 45678.
Wenn keine Gruppen-ID angegeben wird, wird der Teilnehmer nur der Teilnehmerübersichtsseite der Academy und der Gruppe "Jeder" hinzugefügt. Wenn er sich bei der Academy anmeldet, sieht er die Gruppe " Alle" nur, wenn ihr Inhalte hinzugefügt wurden.
Wenn keine Academy ID angegeben wird, wird die erste academy verwendet.
HTTP-Methode: POST
Endpunkt: https: //dashboard.easy-lms.com/?r=api/academy/addParticipant
Erfolgsmeldung
{"Erfolg":true}
Fehler-Antwort
{"success":false, "error": "Beispielfehler"}
Feld - Typ - Beschreibung
apikey - String - Der generierte API-Schlüssel für Ihr Konto. email - String - Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name - String - Der Name des Teilnehmers, den Sie hinzufügen möchten. groups - String - Die IDs der Gruppen, denen Sie den Teilnehmer hinzufügen möchten. Trennen Sie die Gruppen-IDs mit einem Komma.academy - String - Die ID der academy, zu der Sie den Teilnehmer hinzufügen möchten. Wenn keine ID angegeben wird, wird standardmäßig die erste academy verwendet.
Teilnehmer ohne Benachrichtigung hinzufügen
Dieser API-Aufruf fügt einen Teilnehmer zu Ihrer Academy hinzu, sendet aber keine Einladung. Der Einladungslink wird in der Antwort zurückgegeben. Sie können diesen API-Aufruf auch verwenden, um einen Teilnehmer zu einer oder mehreren Gruppen in Ihrer Academy hinzuzufügen.
Die ID der Academy und die Gruppen-ID können in der URL angegeben werden:
In diesem Beispiel lautet die academy ID 123 und die Gruppen ID 45678.
Wenn keine Gruppen-ID angegeben wird, wird der Teilnehmer nur auf der Teilnehmerübersichtsseite der Academy und der Gruppe "Jeder" hinzugefügt. Wenn er sich bei der Academy anmeldet, sieht er die Gruppe " Alle" nur, wenn ihr Inhalte hinzugefügt wurden.
Wenn keine Academy ID angegeben wird, wird die erste academy verwendet.
HTTP-Methode: POST
Erfolgreiche Antwort
`` {
"success":true, "data":{ "playUrl":"https://participant.easy-lms.com/your-academy", "email":"[email protected]", "inviteLink":"https://participant.easy-lms.com/your-academy/set-new-password?..."} }``
Fehlerantwort
{"Erfolg":false, "Fehler": "Beispielfehler" }
Feld - Typ - Beschreibung
- String - Der generierte API-Schlüssel für Ihr Konto. email - String - Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name - String - Der Name des Teilnehmers, den Sie hinzufügen möchten. identifier - String - Der Identifikator für den Teilnehmer in Ihrem System. groups - String - Die IDs der Gruppen, denen Sie den Teilnehmer hinzufügen möchten. Trennen Sie die Gruppen-IDs durch ein Komma.academy - String - Die ID der academy, der Sie den Teilnehmer hinzufügen möchten. Wenn keine ID angegeben wird, wird standardmäßig die erste academy verwendet.
Wenn ein Teilnehmer bereits zu der Prüfung oder Academy hinzugefügt wurde, schlägt die API nicht fehl, sondern aktualisiert die Teilnehmerdaten, wenn die Kennung dieselbe ist.