Przejdź do treści

Dokumentacja API

API dla klientów Smrt English

API tylko do odczytu, które przekazuje dane uczniów i grup do systemów Państwa instytucji. Każdy klucz API ma dostęp wyłącznie do danych własnej instytucji.

Otwórz centrum testowe

Jak to działa

Jak przebiega zapytanie.

Państwa system pobiera dane ucznia lub grupy, używając własnego klucza API, a API zwraca dane tylko do odczytu.

Państwa systemSystem informacji o uczniach lub narzędzie do raportowania.
Państwa klucz APIWysyłany z każdym zapytaniem i przypisany do Państwa szkoły.
Smrt English APIEndpointy tylko do odczytu dla uczniów i grup.
Państwa daneOceny, obecność i listy grup w formacie JSON.
keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

  • X-API-Key (recommended)
  • X-Api-Key
  • HTTP_X_API_KEY (server variable)

Security Notes

  • Keep your API key confidential and do not share it outside your institution
  • Never expose API keys in client-side code or public repositories
  • Use HTTPS for all API requests (enforced in production)
  • Your API key only provides access to your institution's student data