Przejdź do głównej zawartości

Wywołanie API dla 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 application/x-www-form-urlencoded lub multipart/form-data i json.

API kursów

Dodaj uczestnika

To wywołanie API jest przeznaczone dla kursów, które są tylko na zaproszenie.

Metoda HTTP: POST

W adresie URL punktu końcowego zamiast {COURSE_ID} należy wprowadzić identyfikator kursu. Możesz znaleźć ten identyfikator, przechodząc do Dashboard > Kursy > Integracje > API.

Nagłówki:

: application/jsonX-Api-Key: Sekret klucza API

Sekret klucza API można wygenerować (lub zregenerować), przechodząc do Moje konto > Advanced setup > API access. Upewnij się, że zapisałeś sekret klucza API w bezpiecznym miejscu. Po opuszczeniu (lub odświeżeniu) strony NIE będzie on ponownie wyświetlany ze względów bezpieczeństwa!

Treść:

{ "name": "Participant", "email": "participant@email.com"}``` | Po prostu wprowadź nazwę i adres e-mail uczestnika, którego chcesz dodać.   **Pomyślna odpowiedź:** ```{ "status": "ok", "participant": { "name": "Participant", "email": "participant@email.com", "uuid": "4f59ba19-fd70-43f8-bcb2-3b2eb5bd1234" }}

Przykładowa odpowiedź na błąd:

{ "name": "Conflict", "message": "Zduplikowany wpis", "kod": 0, "status": 409}

Jeśli uczestnik został już dodany do kursu, interfejs API nie zawiedzie, ale zaktualizuje dane uczestnika, jeśli identyfikator jest taki sam.

Czy to odpowiedziało na twoje pytanie?