Dzięki naszemu prostemu API możesz automatycznie dodawać uczestników do swoich Egzaminów i Akademii oraz wysyłać im zaproszenia.
Język API
Nasze API akceptuje application/x-www-form-urlencoded lub multipart/form-data i json.
API Egzaminu
Dodaj uczestnika
To wywołanie API działa tylko wtedy, gdy dostęp do egzaminu jest ustawiony na predefiniowaną grupę użytkowników.
Metoda HTTP: POST
Punkt końcowy: https: //dashboard.easy-lms.com/?r=api/exam/addParticipant
Odpowiedź powodzenia
{ "success":true }
Odpowiedź na błąd
{ "success":false, "error": "Przykładowy błąd" }
Pole - Typ - Opis
- String - Wygenerowany klucz API dla Twojego konta. email - String - Adres e-mail uczestnika, którego chcesz dodać. name - String - Imię i nazwisko uczestnika, którego chcesz dodać. examId - Integer - 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
Punkt końcowy: https: //dashboard.easy-lms.com/?r=api/exam/addParticipantWithoutNotifying
Odpowiedź powodzenia
{ "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ź na błąd
{ "success":false, "error": "Example error"}
- Typ - Opis apikey - String - Wygenerowany klucz API dla Twojego konta. email - String - Adres e-mail uczestnika, którego chcesz dodać. name - String - Nazwa uczestnika, którego chcesz dodać. examId - Integer - Identyfikator Egzaminu. identifier - String - Identyfikator uczestnika.
API Akademii
Dodaj uczestnika
To wywołanie API dodaje uczestnika do akademii i powoduje wysłanie do niego wiadomości e-mail z zaproszeniem do akademii. Możesz również użyć tego wywołania API, aby od razu dodać uczestnika do jednej lub więcej grup.
ID akademii i ID grupy mogą znajdować się na końcu adresu URL:
W tym przykładzie ID akademii to 123, a ID grupy to 45678.
Jeśli nie zostanie określony identyfikator grupy, uczestnik zostanie dodany tylko do strony przeglądu uczestników akademii i grupy Wszyscy. Po zalogowaniu się do akademii zobaczy tylko grupę Wszyscy, jeśli dodano do niej zawartość.
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ź na sukces
{"success":true}
Odpowiedź na błąd
{ "success":false, "error": "Przykładowy błąd"}
Pole - Typ - Opis
apikey - String - Wygenerowany klucz API dla Twojego konta. email - String - Adres e-mail uczestnika, którego chcesz dodać. name - String - Nazwa uczestnika, którego chcesz dodać. groups - String - Identyfikatory grup, do których chcesz dodać uczestnika. Oddziel identyfikatory grup przecinkiem.academy - String - Identyfikator akademii, do której chcesz dodać uczestnika. Domyślnie pierwsza akademia, jeśli nie podano identyfikatora.
Dodaj uczestnika bez powiadomienia
To wywołanie API dodaje uczestnika do akademii, ale nie wysyła zaproszenia. Link do zaproszenia zostanie zwrócony w odpowiedzi. Można również użyć tego wywołania API, aby dodać uczestnika do jednej lub więcej grup w akademii.
ID akademii i ID grupy można znaleźć w adresie URL:
W tym przykładzie ID akademii to 123, a ID grupy to 45678.
Jeśli nie zostanie określony identyfikator grupy, uczestnik zostanie dodany tylko do strony przeglądu uczestników akademii i grupy Wszyscy. Po zalogowaniu się do akademii zobaczy tylko grupę Wszyscy, jeśli dodano do niej zawartość.
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/addParticipantWithoutNotifying
Odpowiedź powodzenia
`` {
"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ź na błąd
{ "success":false, "error": "Example error" }
Pole - Typ - Opis
- String - Wygenerowany klucz API dla Twojego konta. email - String - Adres e-mail uczestnika, którego chcesz dodać. name - String - Nazwa uczestnika, którego chcesz dodać. identifier - String - Identyfikator uczestnika w Twoim systemie. groups - String - Identyfikatory grup, do których chcesz dodać uczestnika. Oddziel identyfikatory grup przecinkiem.academy - String - Identyfikator akademii, do której chcesz dodać uczestnika. Domyślnie pierwsza akademia, jeśli nie podano identyfikatora.
Jeśli uczestnik został już dodany do egzaminu lub akademii, interfejs API nie zawiedzie, ale zaktualizuje dane uczestnika, jeśli identyfikator jest taki sam.