关于API v2
随着ClassIn产品功能的升级,ClassIn API 迎来了v2 版本。
相较于之前的ClassIn API(v1),调用上主要区别是:
- 接口URL样式变化,链接中不再携带参数(action=),而是由不同路径决定所使用的接口。
- 使用JSON作为数据交互的格式,不再使用form形式。即请求需要设置 Content-Type:application/json
- 安全校验使用新的签名值参数:X-EEO-SIGN ,取代原来的safeKey,参数放在header,而非body。签名规则请点这里查看
- v2中,时间戳仍为必填参数,但是过期时间由v1的当前调用接口20分钟内,改为5分钟内。
- v2的响应数据格式为json,但是与之前的json数据结构略有不同。结果返回码在第一层参数(code),而不是第二层(error_info->error_code)。
API v1和API v2 是什么关系?
从2024年8月之后新支持的接口,均为API v2形式,之前的接口仍采用API v1 形式。 在未来,会逐步将v1接口更新迭代为v2形式接口。
哪些接口使用API v2
目前 LMS目录下的接口,均使用API v2。其他目录下接口,包括注册用户、创建班级等,仍使用原来的API v1。
具体可以参考每个接口的说明。
目前处于新老版本交替期,所以一次完整的对接,基本都会涉及到两个版本的接口调用。
目前如果想创建一节课,推荐接口调用顺序如何
建议对接用户、创建班级、创建单元、创建课堂,对接课后汇总消息(收取考勤)。完整对接最小集如下:
- 注册用户 (v1接口)
- 创建课程(班级) (v1接口)
- 创建单元 (v2接口)
- 创建课堂 (v2接口)
- 最后,对接课后汇总消息:课节结束后推送的消息
如果想增删单个课的学生,可以调用
注意:以上用了部分v1接口,部分v2接口,两个版本调用方式的不同点已在本文做了说明。
新接口创建课堂活动与老接口创建课节有哪些区别
课堂是LMS活动的一种,是课节的升级版本,当前课节有些属性课堂上没有。
但在后继的产品中,课节概念将逐步被下线,全部替换为课堂。
为避免到时候修改代码,建议新对接的机构使用课堂,而非课节。