Документація API
Клієнтський API Smrt English
API лише для читання, який передає дані учнів і груп у системи вашого закладу. Кожен API-ключ (API key) дає доступ лише до даних свого закладу.
Як це працює
Як виконується запит
Ваша система запитує дані учня або групи за власним API-ключем, а API повертає записи лише для читання.
dnsВаша системаВаша система обліку учнів або інструмент звітності.
arrow_forwardkeyВаш API-ключНадсилається з кожним запитом і прив’язаний до вашого закладу.
arrow_forwardapiAPI Smrt EnglishЕндпоінти (кінцеві точки) для учнів і груп, лише для читання.
arrow_forwardtable_viewВаші даніОцінки, відвідуваність і списки груп у форматі JSON.
Smrt English API
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-KeyHTTP_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