Zum Hauptinhalt springen

API-Aufruf für Kurse

🦉 Easy LMS API-Dokumentation ✓ Kurse ✓ API-Sprache ✓ Teilnehmer hinzufügen

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

Anstelle von {COURSE_ID} müssen Sie die ID des Kurses 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. Bewahren Sie das API-Schlüsselgeheimnis unbedingt an einem sicheren Ort auf. Sobald Sie die Seite verlassen (oder aktualisieren), wird es aus Sicherheitsgründen NICHT mehr 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 Fehlermeldung:

{    "name": "Konflikt",    "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 aktualisiert die Teilnehmerdaten, sofern die Kennung identisch ist.

Hat dies deine Frage beantwortet?