Administracja szkoły
Połącz systemy szkoły z API Smrt English
Odczytuj dane uczniów i grup szkoły we własnych systemach za pomocą klucza API od Smrt English.
API Smrt English pozwala systemom szkoły, takim jak system informacji o uczniach lub panel raportowy, odczytywać dane uczniów i grup. Jest to API tylko do odczytu: nie może niczego dodawać, zmieniać ani usuwać w Smrt English.
Uzyskanie klucza API
Aby poprosić o klucz API (API key) dla szkoły, skontaktuj się z zespołem Smrt English. Klucze wydaje i zarządza nimi zespół Smrt English. Klucz zawsze zwraca wyłącznie uczniów i grupy Państwa szkoły.
Gdy szkoła ma już klucz, otwórz Dashboard, kliknij Home, a następnie Settings. Pole Client API pokazuje, ile kluczy jest aktywnych i ile zapytań wykonały w ciągu ostatnich 30 dni.
Przekaż klucz osobie, która buduje integrację. Wysyła ona klucz w nagłówku X-API-Key każdego zapytania.
Jakie dane można odczytać
- Students: lista uczniów z filtrami i wyszukiwaniem albo jeden uczeń według identyfikatora użytkownika lub adresu e-mail, wraz z jego grupami, ukończonymi zadaniami, testami i czasem nauki.
- Classes: lista grup albo jedna grupa z nauczycielem i listą uczniów.
- Auth: test, który sprawdza, czy klucz działa.
Pełna dokumentacja z przykładami w PHP, Pythonie i JavaScripcie znajduje się w dokumentacji API. Programista może przetestować każdy punkt końcowy (endpoint) w przeglądarce na stronie testowej, do której prowadzi link w dokumentacji.
Traktuj klucz jak hasło. Przechowuj go na serwerze, nigdy na stronie internetowej ani w aplikacji. Jeśli klucz mógł zostać ujawniony, natychmiast skontaktuj się z zespołem Smrt English.
