運作方式
請求的處理流程
您的系統以自己的API金鑰請求某位學生或某個班級的資料,API以唯讀方式回傳相應紀錄。
dns您的系統您的學生資訊管理系統或報表工具。
arrow_forwardkey您的API金鑰隨每個請求一同傳送,並與您的學校綁定。
arrow_forwardapiSmrt English API提供學生與班級資料的唯讀端點。
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