Przejdź do głównej zawartości

Wywołanie API dotyczące kursów

🦉 Dokumentacja API Easy LMS ✓ Kursy ✓ Język API ✓ Dodaj uczestnika

Dzięki naszemu prostemu API możesz automatycznie dodawać uczestników do swoich kursów i wysyłać im zaproszenia.

Język API

Nasze API akceptuje formaty application/x-www-form-urlencoded, multipart/form-data oraz JSON.

API kursów

Dodaj uczestnika

To wywołanie API dotyczy kursów dostępnych wyłącznie na zaproszenie.

Metoda HTTP: POST

W adresie URL punktu końcowego należy wpisać identyfikator kursu w miejsce {COURSE_ID}. Identyfikator ten można znaleźć, przechodząc do sekcji Pulpit nawigacyjny > Kursy > Kurs > Integracje > API.

Nagłówki:

: application/jsonX-Api-Key: tajny klucz API

Sekret klucza API można wygenerować (lub wygenerować ponownie), przechodząc do sekcji Moje konto > Ustawienia Advanced > Dostęp do API. Należy zapisać sekret klucza API w bezpiecznym miejscu. Po opuszczeniu (lub odświeżeniu) strony nie zostanie on ponownie wyświetlony ze względów bezpieczeństwa!

Treść:

{  "name": "Uczestnik",  "email": "participant@email.com"}```  | Wystarczy wpisać imię i nazwisko oraz adres e-mail uczestnika, którego chcesz dodać.   **Odpowiedź potwierdzająca:**  ```{    "status": "ok",    "participant": {        "name": "Participant",        "email": "participant@email.com",        "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234"    }}

Przykładowa odpowiedź o błędzie:

{    "name": "Conflict",    "message": "Duplikowany wpis",    "code": 0,    "status": 409}

Jeśli uczestnik został już dodany do kursu, API nie zwróci błędu, ale zaktualizuje dane uczestnika, jeśli identyfikator jest taki sam.

Czy to odpowiedziało na twoje pytanie?