快速实现从用户同步到在线课堂创建
本文档介绍 ClassIn API 最基础的对接方案,帮助您快速了解如何将用户与排课数据同步至 ClassIn 平台。
文档以典型业务场景为例:用户在您的平台注册并加入某个课堂后,您的平台后端需依次调用哪些接口,完成用户身份同步与课堂创建。
注意: 本方案面向快速对接场景,重点覆盖数据的创建与同步流程。如需完整对接,还应补充数据修改、删除等操作。
数据同步须知
API 对接采用单向同步机制,即数据仅从您的平台流向 ClassIn,ClassIn 侧的操作不会反向同步至您的平台。为避免两套系统数据不一致,建议遵守以下规范:
- 本地存储关键 ID:平台应持久化存储用户 UID、课程 ID、课节 ID 等关联数据;
- 限制后台权限:机构子账号非必要不授予"课程中心"权限;
- 课程勿设班主任:非必要情况下不为课程设置班主任;
- 限制教师建班权限:中小学场景下,非必要不授予教师"客户端建班/公开课"权限。
一、添加用户
排课前需先完成用户同步,将用户注册到 ClassIn 并赋予对应身份。UID 是用户在 ClassIn 的唯一标识,同一 UID 可在同一机构下同时拥有多种身份(教师、学生、后台子账号等)。
1.1 流程说明
- 调用注册用户接口获取用户 UID,并传入
addToSchoolMember参数,将用户添加为指定身份(教师或学生); - 也可在注册后单独调用添加老师或添加学生接口追加身份。推荐优先使用注册接口一步完成注册与身份绑定。
1.2 注意事项
- 若用户已注册 ClassIn,传入
addToSchoolMember仍可将其加入机构并赋予对应身份,但不会重置账号密码、头像和昵称; - 添加接口(添加老师、添加学生)返回的
data为用户与学校的关系 ID,排课时请使用注册接口返回的 UID,而非该关系 ID。
二、排课方案
前提: 以下所有排课操作均应在完成添加用户后进行。
方案一:学校统一排课
适用场景: 教育机构或学校统一管理课程,由管理员或教师在平台侧完成班级创建与排课,学生按时进入教室上课。
| 步骤 | 操作 | 参考文档 |
|---|---|---|
| Step 1 | 根据平台课程(班级)信息创建课程 | 创建课程 |
| Step 2 | 将学生批量添加至课程 | 添加单个学生 / 批量添加 |
| Step 3 | 创建单元与课堂 | 创建单元 / 创建课堂 |
方案二:约课平台排课
适用场景: 1v1 或小班约课平台,学生按需预约课时,支持灵活调课与人员调整。
| 步骤 | 操作 | 参考文档 |
|---|---|---|
| Step 1 | 为学生创建专属课程 | 创建课程 |
| Step 2 | 将学生添加至专属课程 | 添加单个学生 |
| Step 3 | 根据预约信息创建单元与课堂 | 创建单元 / 创建课堂 |
| Step 4 | 发生调课时,针对单个课堂调整人员 | 添加活动成员 / 删除活动成员 |
提示: 1v1 场景中,同一学生的所有课节应复用同一课程,无需为每个课节单独创建课程。
方案三:基于 LMS 学习系统排课
适用场景: 使用 ClassIn LMS 学习系统管理课程结构,支持单元化课程组织,课堂创建后自动出现在学生的 LMS 活动列表中。
| 步骤 | 操作 | 参考文档 |
|---|---|---|
| Step 1 | 根据平台班级信息创建课程 | 创建课程 |
| Step 2 | 将学生批量添加至课程 | 添加单个学生 / 批量添加 |
| Step 3 | 创建单元与课堂 | 创建单元 / 创建课堂 |
说明: 课堂创建成功后,将自动出现在 LMS 课程单元活动列表中,学生可直接在 ClassIn 客户端按时进入教室。目前其他类型活动(如作业、考试)仍需在客户端创建或从 TeacherIn 导入。
常见问题
Q:我们是 1v1 课程,对接后学生端出现了很多班级,怎么回事?
这通常是因为为同一学生的每个课节都创建了独立课程导致的。正确做法是:同一学生的所有课节复用同一个课程,仅在该课程下创建不同课堂即可。