Мазмұнға өту

API құжаттамасы

Smrt English Client API

Білім алушылар мен топтар туралы деректерді оқу орныңыздың жүйелеріне беретін, тек оқуға арналған API. Әр API кілті (API key) тек өз оқу орнының деректеріне қол жеткізеді.

Тестілеу орталығын ашу

Қалай жұмыс істейді

Сұрау қалай жұмыс істейді

Жүйеңіз білім алушы немесе топ деректерін өз API кілтімен (API key) сұрайды, ал API деректерді тек оқу режимінде қайтарады.

Сіздің жүйеңізБілім алушылар туралы ақпараттық жүйеңіз немесе есеп құралыңыз.
Сіздің API кілтіңізӘр сұраумен бірге жіберіледі және мектебіңізге байланған.
Smrt English APIБілім алушылар мен топтарға арналған, тек оқуға арналған эндпоинттер.
Сіздің деректеріңізБағалар, сабаққа қатысу және топ тізімдері 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