跳至主要內容

API文件

Smrt English客戶API

這是一個唯讀API,將學生與班級紀錄回傳至您機構的系統。每個API金鑰(API key)只能存取其所屬機構的資料。

開啟測試中心

運作方式

請求的處理流程

您的系統以自己的API金鑰請求某位學生或某個班級的資料,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