跳至正文

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