ClassIn API 知识库技能使用指南
让 AI 成为你最靠谱的 ClassIn 对接专家
一、背景介绍
随着 AI 编程助手（如 WorkBuddy 龙虾、Cursor、GitHub Copilot 等）的普及，越来越多机构开始借助 AI 进行 ClassIn API 的对接开发。AI 编程助手在回答问题之前，需要先"学习"相关的接口知识，而这些知识通常来自开发者自行整理或搜索到的文档片段。
然而，这种方式存在明显隐患：
- 信息不准确：网络上流传的 ClassIn 文档版本不一，可能包含已废弃的旧接口、错误参数名、过时的签名方式等
- 覆盖不全面：如果提供官网文档网址给AI学习，AI仅学习部分网页。或者开发者往往只整理自己用到的接口，遇到其他模块时 AI 无法提供正确答案。
- 更新不及时：ClassIn API 持续迭代（如 6.0 版本将课节迁移为课堂活动），旧知识库无法感知变化
- 排查成本高：AI 给出错误代码后，开发者需要反复调试才能发现是知识来源有问题，而不是代码逻辑有问题
为解决这些问题，ClassIn 推出了官方 API 知识库 Skill。这是一个专为 AI 编程助手设计的知识插件，内含由 ClassIn 官方维护的完整 API 文档，并通过 RAG（检索增强生成）技术，让 AI 在回答开发问题时，精准定位并引用正确的官方文档内容。
二、适用人群
| 人群 | 典型场景 |
|---|---|
| 刚开始对接的新手开发者 | 不知道从哪里入手，需要 AI 一步步引导完成注册用户→创建课程→排课的全流程 |
| 正在对接 ClassIn API 的开发者 | 不熟悉接口参数、签名方式，想用 AI 快速生成可用代码 |
| 使用 AI 辅助编程的技术团队 | 团队成员较多，对接口功能理解程度不同，希望 AI 给出统一、准确的接口用法 |
| 遇到报错需要排查的开发者 | 遇到 API 返回错误码，想快速定位原因和修复方式 |
三、Skill 覆盖范围
本 Skill 收录约 70+ 个 API 接口 及 40+ 消息订阅类型 ，覆盖 ClassIn API 全部功能模块：
| 模块 | 接口数 | 主要能力 |
|---|---|---|
| 用户管理 | 11 | 注册用户、添加老师/学生、修改密码、启用停用账号 |
| 课程课节 | 23 | 创建/编辑/删除课程，创建/修改/删除课节，添加老师/学生 |
| LMS 活动 | 11 | 单元管理、课堂活动创建与发布、活动成员管理 |
| 云盘操作 | 9 | 文件夹/文件上传 |
| 直播录制 | 5 | 录课设置、直播地址、回放地址获取 |
| 机构管理 | 4 | 机构标签、学校设置 |
| 双师课 | 3 | 创建/编辑/删除在线双师课节 |
| 消息订阅 | 40+ | 实时推送、课后数据推送、活动信息同步 |
| 其他 | 2 | 获取客户端链接接口，班级群接口 |
四、下载与安装
以WorkBuddy（龙虾）为例，说明技能的安装及初始化过程。
4.1 获取 Skill 安装包
前往 ClassIn 官方渠道 https://github.com/wanqinzheng/classin-api-docs 获取zip包。
4.2 在 WorkBuddy（龙虾）中安装
方法 A：技能中心一键导入（推荐）
- 打开 WorkBuddy（龙虾）客户端
- 点击左侧导航栏 「专家」 或 「技能」 入口
- 选择 「导入本地技能包」
- 选择下载好的
classin-api-docs.zip文件 - 导入完成后，Skill 自动出现在技能列表中
方法 B：手动复制安装
将skill文件夹复制粘贴到龙虾的skills目录。
# Windows（在命令提示符或 PowerShell 中执行）
xcopy /E /I classin-api-docs %USERPROFILE%\.workbuddy\skills\classin-api-docs
# macOS / Linux
cp -r classin-api-docs ~/.workbuddy/skills/
4.3 安装运行依赖
# 进入 Skill 目录
cd ~/.workbuddy/skills/classin-api-docs # macOS/Linux
# 或
cd %USERPROFILE%\.workbuddy\skills\classin-api-docs # Windows
# 安装依赖库
pip install -r scripts/requirements.txt
⚠️ 需要 Python 3.9 及以上版本
4.4 建立向量索引（首次必须执行）
python scripts/build_index.py
💡 首次运行会自动下载嵌入模型（约 400MB），之后本地缓存，无需重复下载。
安装完成后，Skill 即可被 WorkBuddy 的 AI 助手自动调用。
五、使用方法
安装完成后，无需任何额外配置，直接在 WorkBuddy 对话框中用自然语言提问即可。AI 会自动识别 ClassIn API 相关问题，调用 Skill 检索官方文档给出回答。如果您的本地安装多种类似技能，或者初次提问，建议带上API，ClassIn 等关键字。
注：skill主要提供RGA功能，其他AI语义分析，代码编写等依赖龙虾agent本身的能力。
5.1 直接提问
你可以用任何自然语言表达你的开发需求：
创建课程需要哪些参数？
添加学生的接口怎么用？
safeKey 签名规则是什么？
API 返回 102 错误码是什么意思？
LMS 创建课堂活动和旧版创建课节有什么区别？
5.2 粘贴错误信息排查
直接把报错截图或错误信息发给 AI，配合提问：
调用 addCourse 返回了 {"errno": 100}，请问是什么问题？
这段代码创建课节时总是报参数错误，帮我看看哪里不对：
[粘贴你的代码]
5.3 生成代码示例
指定接口名和编程语言，让 AI 直接生成可用代码：
用 Python 帮我写一个调用 addCourse 创建课程的示例
用 Node.js 实现注册用户并添加到机构的完整代码
5.4 了解最新接口变化
ClassIn 6.0 课节迁移成课堂活动之后，我原来的排课接口还能用吗？
新的 LMS 接口和旧的课节接口有什么区别，我需要改代码吗？
六、实际使用案例
注：以下问答为精简过的版本非原始AI问答。
案例 1：新开发者快速入门
背景：某在线教育平台需要接入 ClassIn，开发者第一次对接，不知道从何开始。
对话过程：
开发者：我刚拿到 ClassIn 的 SID 和 SECRET，我想实现学生在我平台注册后自动同步到 ClassIn 并加入对应课程，应该怎么做？
AI（调用 Skill 后回答）：根据 ClassIn 官方文档，完整流程分为以下几步：
- 调用
register接口注册用户，获取UID- 调用
addCourse创建课程，获取courseId（课程已存在则跳过）- 调用
addCourseStudent将学生添加到课程下- 调用
LMS/createUnit+LMS/createClassroom创建课堂活动（6.0 推荐方式）以下是 Python 示例代码……
效果：开发者无需翻阅文档，一次对话完成整体流程梳理，当天完成基础对接。
案例 2：API 报错快速定位
背景：开发者调用 addCourse 接口，返回 {"errno": 398}，不知道含义。
对话过程：
开发者：调用创建课程接口返回 errno 398，是什么意思？
AI（调用 Skill 后回答）：根据
addCourse接口的错误码说明，398 表示"数据已经存在（唯一标识已存在）"。你传入了courseUniqueIdentity参数，但该标识对应的课程已在系统中存在。解决方案：
- 复用已有课程时，直接使用该唯一标识对应的 courseId
- 需要新建课程时，更换一个不同的
courseUniqueIdentity值
效果：30 秒内定位问题根源，无需联系相关技术支持。
案例 3：版本迁移咨询
背景：老客户使用旧版课节接口运行多年，ClassIn 6.0 发布后担心接口失效。
对话过程：
开发者：ClassIn 6.0 说课节迁移成了课堂活动，我现在还在用 addCourseClass，这个接口还能用吗？
AI（调用 Skill 后回答）：根据 ClassIn 6.0 官方说明，旧版课节接口仍然可以继续使用，ClassIn 已做向下兼容处理：
- 调用
addCourseClass创建的课节会自动转换为"默认课程—默认单元"下的课堂活动- 返回的 classId 仍然有效，可用于修改、删除等后续操作
你无需立即修改代码。 但官方建议有条件的机构逐步迁移至 LMS 接口以支持新功能。
效果：消除迁移焦虑，"不用改"的结论有官方文档背书，团队安心。
案例 4：签名生成调试
背景：开发者自己实现了 safeKey 签名，但总是返回 102（无权限）。
对话过程：
开发者：我的 safeKey 算法是 MD5(SECRET + timeStamp)，为什么总是返回 102？
AI（调用 Skill 后回答）：根据 Error-Handling/Basic_errors.md 和 appendix/Gettingstartedguide.md，102 错误有 7 大原因： 编号 原因 常见踩坑
- SID 不正确 复制时多/少了字符
- safeKey 算法不对 ⚠️ 最常见！见下方详解
- SECRET 手动输入出错 字母混淆：0/O、1/l/I、大小写
- timeStamp 过期 超过 20 分钟，或用了毫秒而非秒
- 机构无 API 对接权限 eeo.cn 后台确认
- 接口已下线 旧版接口可能已废弃
- 机构账号欠费/到期 联系客户经理
你的算法 MD5(SECRET + timeStamp) 本身是对的（文档原文：safeKey=MD5(SECRET+timeStamp)）。问题大概率出在实现细节上。让我写一个诊> 断脚本帮你逐步排查：
效果：精准给出排查方向，开发者 5 分钟内找到问题（SECRET 含尾随空格）。
七、常见问题
Q：安装后 AI 没有自动调用这个 Skill 怎么办？
在提问时明确加上「ClassIn API」「eeo 接口」等关键词，帮助 AI 识别意图触发 Skill；也可以在 WorkBuddy 设置中手动检查 Skill 是否已启用。
Q：Skill 里的文档是最新版本吗？
本 Skill 由 ClassIn 官方维护，包含截至当前的最新接口说明（最新版本 ClassIn 6.0.5）。如有文档更新，重新下载安装包并执行 python scripts/build_index.py --rebuild 重建索引即可。
Q：可以在没有网络的环境使用吗？
Skill本身可以离线使用。嵌入模型首次下载后本地缓存，向量库（ChromaDB）完全本地运行。默认 local 模式完全离线；如选择 llm 模式则需联网调用在线 LLM。
Q：支持哪些编程语言的代码生成？
WorkBuddy 支持 Python、Node.js、Java、PHP、Go 五种语言。如果使用其他龙虾，取决于龙虾本身的能力。
Q：可以用于非 WorkBuddy 的 AI 工具吗？
Skill 包内的 references/ 目录是标准 Markdown 格式，理论上可以导入任何支持本地知识库的 AI 工具（如 Cursor、Continue 等），但需要手动配置，WorkBuddy 提供开箱即用体验。
八、联系与支持
如在使用过程中发现文档有误、接口信息不准确，或有功能建议，欢迎通过以下渠道反馈：
- ClassIn 官方技术支持
- 联系 ClassIn 技术对接负责人
本文档由 ClassIn 官方提供，适用于 WorkBuddy（龙虾）平台 classin-api-docs Skill v1.x