通过Smrt English API连接您的系统

Smrt English API可以让学校的系统（例如学生信息系统或报告平台）读取您的学生和班级记录。该API为只读：它不能在Smrt English中添加、修改或删除任何内容。

获取API密钥

请联系Smrt English为您的学校申请API密钥（API key）。API密钥由Smrt English签发和管理。一个API密钥只会返回您本校的学生和班级。

1. 学校获得API密钥后，打开Dashboard（管理后台），点击Home，然后点击Settings（设置）。Client API框显示当前有效的密钥数量，以及这些密钥在过去30天内的请求次数。

   

2. 将API密钥交给负责开发集成的人员。每次请求时，将其放在X-API-Key请求头中发送。

可以读取的内容

• Students（学生）：学生列表（支持筛选和搜索），或按用户ID或电子邮箱地址读取单个学生，包括其班级、已完成的作业、测评和学习时长。
• Classes（班级）：班级列表，或单个班级及其教师和学生名单。
• Auth（验证）：用于检查API密钥是否有效的测试。

完整的参考文档（含PHP、Python和JavaScript示例）见API文档。您的开发人员可以通过其中链接的测试页面，在浏览器中试用每个接口。