API belgeleri
Smrt English Client API
Öğrenci ve sınıf kayıtlarını kurumunuzun sistemlerine aktaran, yalnızca okuma amaçlı bir API. Her API anahtarı (API key) yalnızca kendi kurumunun verilerine erişir.
Nasıl çalışır
Bir isteğin işleyişi
Sisteminiz kendi API anahtarıyla bir öğrenciyi ya da sınıfı sorgular; API de kayıtları yalnızca okuma amaçlı olarak döndürür.
dnsSisteminizÖğrenci bilgi sisteminiz ya da raporlama aracınız.
arrow_forwardkeyAPI anahtarınızHer istekle gönderilir ve okulunuza bağlıdır.
arrow_forwardapiSmrt English APIÖğrenciler ve sınıflar için yalnızca okuma amaçlı endpoint’ler.
arrow_forwardtable_viewKayıtlarınızJSON biçiminde notlar, devam kayıtları ve sınıf listeleri.
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