Dzięki naszemu prostemu API możesz automatycznie dodawać uczestników do egzaminu i akademii oraz wysyłać im zaproszenia.
Język API
Nasze API akceptuje formaty application/x-www-form-urlencoded, multipart/form-data oraz JSON.
API egzaminu
Dodaj uczestnika
To wywołanie API działa tylko wtedy, gdy dostęp do egzaminu jest ustawiony na Wstępnie zdefiniowaną grupę użytkowników.
Metoda HTTP: POST
Punkt końcowy: https://dashboard.easy-lms.com/?r=api/exam/addParticipant
Odpowiedź z sukcesem
{ "success":true }
Odpowiedź o błędzie
{ "success":false, "error":"Przykładowy błąd" }
Pole – Typ – Opis
- Ciąg znaków – Wygenerowany klucz API dla Twojego konta. email – Ciąg znaków – Adres e-mail uczestnika, którego chcesz dodać. name – ciąg znaków – imię i nazwisko uczestnika, którego chcesz dodać. examId – liczba całkowita – identyfikator egzaminu.
Dodaj uczestnika bez powiadamiania
Dodaj uczestnika do egzaminu bez wysyłania mu zaproszenia. Dane logowania zostaną zwrócone w odpowiedzi.
Metoda HTTP: POST
Odpowiedź o pomyślnym zakończeniu
{ "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":"ExampleAuthenticationCode" } }
Odpowiedź z błędem
{ "success":false, "error":"Przykładowy błąd"}
- Typ - Opis apikey - Ciąg znaków - Wygenerowany klucz API dla Twojego konta. email - Ciąg znaków - Adres e-mail uczestnika, którego chcesz dodać. name - Ciąg znaków - Imię i nazwisko uczestnika, którego chcesz dodać. examId - Liczba całkowita - Identyfikator egzaminu. identifier – ciąg znaków – identyfikator uczestnika.
API Akademii
Dodaj uczestnika
To wywołanie API dodaje uczestnika do akademii i powoduje wysłanie do niego e-maila z zaproszeniem do akademii. Możesz również użyć tego wywołania API, aby od razu dodać uczestnika do jednej lub kilku grup.
Identyfikator akademii i identyfikator grupy znajdują się na końcu adresu URL:
W tym przykładzie identyfikator akademii to 123, a identyfikator grupy to 45678.
Jeśli nie podano identyfikatora grupy, uczestnik zostanie dodany wyłącznie do strony Przegląd uczestników akademii oraz do grupy Wszyscy. Po zalogowaniu się do akademii uczestnik zobaczy grupę Wszyscy tylko wtedy, gdy dodano do niej treści.
Jeśli nie podano identyfikatora akademii, zostanie użyta pierwsza akademia.
Metoda HTTP: POST
Punkt końcowy: https://dashboard.easy-lms.com/?r=api/academy/addParticipant
Odpowiedź potwierdzająca sukces
{ "success":true}
Odpowiedź z błędem
{ "success":false, "error":"Przykładowy błąd"}
Pole – Typ – Opis
apikey – Ciąg znaków – Wygenerowany klucz API dla Twojego konta. email – ciąg znaków – adres e-mail uczestnika, którego chcesz dodać. name – ciąg znaków – imię i nazwisko uczestnika, którego chcesz dodać. groups – ciąg znaków – identyfikatory grup, do których chcesz dodać uczestnika. Identyfikatory grup należy oddzielać przecinkami. academy — ciąg znaków — identyfikator akademii, do której chcesz dodać uczestnika. Jeśli nie podano identyfikatora, domyślnie wybierana jest pierwsza akademia.
Dodaj uczestnika bez powiadamiania
To wywołanie API dodaje uczestnika do Twojej akademii, ale nie wysyła zaproszenia. Link z zaproszeniem zostanie zwrócony w odpowiedzi. Możesz również użyć tego wywołania API, aby dodać uczestnika do jednej lub kilku grup w Twojej akademii.
Identyfikator akademii i identyfikator grupy można znaleźć w adresie URL:
W tym przykładzie identyfikator akademii to 123, a identyfikator grupy to 45678.
Jeśli nie podano identyfikatora grupy, uczestnik zostanie dodany wyłącznie do strony Przegląd uczestników akademii oraz do grupy Wszyscy. Po zalogowaniu się do akademii uczestnik zobaczy grupę Wszyscy tylko wtedy, gdy dodano do niej treści.
Jeśli nie podano identyfikatora akademii, zostanie użyta pierwsza akademia.
Metoda HTTP: POST
Odpowiedź z potwierdzeniem sukcesu
`` {
"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?..." } }``
Odpowiedź z błędem
{ "success":false, "error":"Przykładowy błąd" }
Pole – Typ – Opis
- Ciąg znaków - Wygenerowany klucz API dla Twojego konta. email - Ciąg znaków - Adres e-mail uczestnika, którego chcesz dodać. name - Ciąg znaków - Imię i nazwisko uczestnika, którego chcesz dodać. identifier - Ciąg znaków - Identyfikator uczestnika w Twoim systemie. groups – ciąg znaków – identyfikatory grup, do których chcesz dodać uczestnika. Identyfikatory grup należy oddzielać przecinkami. academy – ciąg znaków – identyfikator akademii, do której chcesz dodać uczestnika. Jeśli nie podano identyfikatora, domyślnie wybrana zostanie pierwsza akademia.
Jeśli uczestnik został już dodany do egzaminu lub akademii, wywołanie API nie zakończy się niepowodzeniem, ale dane uczestnika zostaną zaktualizowane, jeśli identyfikator jest taki sam.