Mit unserer einfachen API können Sie Teilnehmer automatisch zu Ihrer Prüfung und Ihrer Academy hinzufügen und ihnen eine Einladung senden.
API-Sprache
Unsere API akzeptiert die Formate „application/x-www-form-urlencoded“, „multipart/form-data“ und „json“.
Prüfungs-API
Teilnehmer hinzufügen
Dieser API-Aufruf funktioniert nur, wenn der Zugriff auf Ihre Prüfung auf „Eine vordefinierte Benutzergruppe“ eingestellt ist.
HTTP-Methode: POST
Erfolgsantwort
{ "success":true }
Fehlerantwort
{ "success":false, "error":"Beispielfehler" }
Feld – Typ – Beschreibung
- Zeichenkette – Der generierte API-Schlüssel für Ihr Konto. E-Mail – Zeichenkette – Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. Name – Zeichenkette – Der Name des Teilnehmers, den Sie hinzufügen möchten. examId – Ganzzahl – Die ID der Prüfung.
Teilnehmer hinzufügen, ohne ihn zu benachrichtigen
Fügen Sie einen Teilnehmer zu Ihrer Prüfung hinzu, ohne ihm eine Einladung zu senden. Die Anmeldedaten werden in der Antwort zurückgegeben.
HTTP-Methode: POST
Erfolgsantwort
{ "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":"Beispiel-Authentifizierungscode" } }
Fehlermeldung
{ "success":false, "error":"Beispielfehler"}
- Typ - Beschreibung apikey - Zeichenkette - Der für Ihr Konto generierte API-Schlüssel. email - Zeichenkette - Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name - Zeichenkette - Der Name des Teilnehmers, den Sie hinzufügen möchten. examId – Ganzzahl – Die ID der Prüfung. identifier – Zeichenkette – Die Kennung des Teilnehmers.
Academy-API
Teilnehmer hinzufügen
Dieser API-Aufruf fügt einen Teilnehmer zu einer academy hinzu und löst den Versand der Einladungs-E-Mail zur academy an diesen Teilnehmer aus. Sie können diesen API-Aufruf auch nutzen, um den Teilnehmer sofort einer oder mehreren Gruppen hinzuzufügen.
The academy ID and group ID are located at the end of the URL:
In diesem Beispiel lautet die Academy-ID 123 und die Gruppen-ID 45678.
Wird keine Gruppen-ID angegeben, wird der Teilnehmer lediglich zur Teilnehmerübersicht der Academy und zur Gruppe „Alle“ hinzugefügt. Wenn er sich bei der Academy anmeldet, sieht er nur die Gruppe „Alle“, sofern dort Inhalte hinzugefügt wurden.
Wird keine Academy-ID angegeben, wird die erste Academy verwendet.
HTTP-Methode: POST
Erfolgsantwort
{ "success":true}
Fehlerantwort
{ "success":false, "error":"Beispielfehler"}
Feld – Typ – Beschreibung
apikey – Zeichenfolge – Der für Ihr Konto generierte API-Schlüssel. email – Zeichenfolge – Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name – Zeichenfolge – Der Name des Teilnehmers, den Sie hinzufügen möchten. groups – Zeichenfolge – Die IDs der Gruppen, zu denen Sie den Teilnehmer hinzufügen möchten. Trennen Sie die Gruppen-IDs durch ein Komma.academy – Zeichenkette – Die ID der Academy, der Sie den Teilnehmer hinzufügen möchten. Standardmäßig wird die erste Academy verwendet, wenn keine ID angegeben wird.
Teilnehmer hinzufügen, ohne eine Benachrichtigung zu senden
Dieser API-Aufruf fügt einen Teilnehmer zu Ihrer academy hinzu, versendet jedoch 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.
The Academy ID and group ID are found in the URL:
In diesem Beispiel lautet die Academy-ID 123 und die Gruppen-ID 45678.
Wenn keine Gruppen-ID angegeben wird, wird der Teilnehmer nur zur Teilnehmerübersicht der Academy und zur Gruppe „Alle“ hinzugefügt. Wenn er sich bei der Academy anmeldet, sieht er nur die Gruppe „Alle“, sofern Inhalte zu dieser Gruppe hinzugefügt wurden.
Wird keine Academy-ID angegeben, wird die erste Academy verwendet.
HTTP-Methode: POST
Erfolgsantwort
`` {
"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?..." } }``
Fehlermeldung
{ „success“: false, „error“: „Beispielfehler“ }
Feld – Typ – Beschreibung
- Zeichenfolge – Der generierte API-Schlüssel für Ihr Konto. email – Zeichenfolge – Die E-Mail-Adresse des Teilnehmers, den Sie hinzufügen möchten. name – Zeichenfolge – Der Name des Teilnehmers, den Sie hinzufügen möchten. identifier – Zeichenfolge – Die Kennung des Teilnehmers in Ihrem System. groups – Zeichenfolge – Die IDs der Gruppen, zu denen Sie den Teilnehmer hinzufügen möchten. Trennen Sie die Gruppen-IDs durch Kommas.academy – Zeichenfolge – Die ID der Akademie, zu der Sie den Teilnehmer hinzufügen möchten. Standardmäßig wird die erste Akademie verwendet, wenn keine ID angegeben wird.
Wenn ein Teilnehmer bereits zur Prüfung oder Academy hinzugefügt wurde, schlägt der API-Aufruf nicht fehl, sondern aktualisiert die Teilnehmerdaten, sofern die Kennung übereinstimmt.