Mit unserer einfachen API können Sie Teilnehmer automatisch zu Ihren Kursen hinzufügen und ihnen eine Einladung senden.
API-Sprache
Unsere API akzeptiert die Formate „application/x-www-form-urlencoded“, „multipart/form-data“ und JSON.
Kurs-API
Teilnehmer hinzufügen
Dieser API-Aufruf ist für Kurse vorgesehen, die nur auf Einladung zugänglich sind.
HTTP-Methode: POST
Endpunkt:https://dashboard-api.easy-lms.com/v1/course/%7BCOURSE_ID%7D/add-participanteasy-lms.com/v1/kurs/{COURSE_ID}/add-participant
Sie müssen die ID des Kurses anstelle von {COURSE_ID} in die Endpunkt-URL eingeben. Diese ID finden Sie unter Dashboard > Kurse > Kurs > Integrationen > API.
Header:
: application/jsonX-Api-Key: API-Schlüssel-Geheimnis
Das API-Schlüsselgeheimnis kann unter Mein Konto > Advanced Einstellungen > API-Zugriff generiert (oder neu generiert) werden. Achten Sie darauf, das API-Schlüsselgeheimnis an einem sicheren Ort zu speichern. Sobald Sie die Seite verlassen (oder aktualisieren), wird er aus Sicherheitsgründen NICHT erneut angezeigt!
Inhalt:
{ "name": "Teilnehmer", "email": "participant@email.com"}``` | Geben Sie einfach den Namen und die E-Mail-Adresse des Teilnehmers ein, den Sie hinzufügen möchten. **Erfolgsantwort:** ```{ "status": "ok", "participant": { "name": "Participant", "email": "participant@email.com", "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234" }}
Beispiel für eine Fehlerantwort:
{ "name": "Conflict", "message": "Doppelte Eingabe", "code": 0, "status": 409}Wenn ein Teilnehmer bereits zu einem Kurs hinzugefügt wurde, schlägt der API-Aufruf nicht fehl, sondern die Teilnehmerdaten werden aktualisiert, sofern die Kennung identisch ist.