伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. 云学堂模块化SDK
  • 产品介绍
    • SDK简介
    • SDK支持的业务场景
    • 产品特色
  • 产品功能
    • 实时课堂功能介绍
    • 微课功能介绍
    • 上传课件功能介绍
    • SDK后台功能介绍
  • 接入指引
    • SDK对接标准流程说明
    • 关键概念
  • SDK接入
    • SDK 接入总览
    • 实时课堂
      • Android 实时课堂接入
      • Harmony 实时课堂接入
      • iOS 实时课堂接入
      • Electron 实时课堂接入
      • Web 实时课堂监课接入
    • 极速课堂
      • Android 极速课堂接入
      • Harmony 极速课堂接入
      • iOS 极速课堂接入
      • Electron 极速课堂接入
    • 微课
      • Android 微课接入
      • Harmony 微课接入
      • iOS 微课接入
      • Electron 微课接入
    • 资料中心
      • Android 资料中心接入
      • Harmony 资料中心接入
      • iOS 资料中心接入
      • Electron 资料中心接入
      • Web 资料中心接入
    • 文件预解析
      • Android 文件预解析接入
      • Harmony 文件预解析
      • iOS 文件预解析接入
      • Electron 文件预解析接入
    • 历史课堂回放
      • Android 历史课堂回放
      • Harmony 历史课堂回放
      • iOS 历史课堂回放
      • Electron 历史课堂回放
      • 播放器
        • 播放器 SDK 概述
        • 播放器 SDK 快速开始
        • 播放器 SDK 初始化与配置
        • 播放器 SDK 历史课堂回放
        • 播放器 SDK 移动端 WebView 嵌入
        • 播放器 SDK API 参考
        • 播放器 SDK 事件
        • 播放器 SDK 错误码
        • 播放器 SDK 常见问题
    • 云学堂模块化SDK
      • 云学堂模块化 SDK 概述
      • 云学堂模块化 SDK · Android 接入
      • 云学堂模块化 SDK · iOS 接入
      • 云学堂模块化 SDK · Harmony 接入
      • 云学堂模块化 SDK · PC 接入
      • 伯索云学堂跳转接入
    • 服务端接口与协议
      • 服务端接口与协议阅读顺序
      • 签名与鉴权
      • 签名示例
      • query 参数
      • 资料中心与文件 URL
      • 文档预解析
      • 历史课堂数据回调
      • 历史课堂转视频与下载
    • 接入基础(Electron & Web)
      • Web
        • Web 概述
        • Web 快速开始:URL 接入监课
        • Web 初始化与配置(监课)
        • Web API 参考(监课)
        • Web 事件与回调(监课)
        • Web 错误码(监课)
        • Web 常见问题(监课)
      • Electron
        • Electron 概述
        • Electron 快速开始
        • Electron 初始化与配置
        • Electron API 参考
        • Electron 事件与回调
        • Electron 错误码
        • Electron 常见问题
  • Open API
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
      • 恢复删除的用户
      • 设置学生属性(是否跟随/是否加联/分配课程顾问)
      • 学生随机分配课程顾问(V2)
      • 根据ids,批量查询用户
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
      • 批量绑定老师到班级
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 查询课堂下历史课堂信息
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
      • 获取课堂中引用的课件列表
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
      • 获取学生课程统计数据
      • 获取学生课程详情统计数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
    • 积分管理
      • 机构积分规则
      • 查下学生当前积分数
      • 查下机构每天的积分明细记录
    • 课程顾问
      • 新建课程顾问
      • 编辑课程顾问
      • 查询课程顾问
      • 停用/启用课程顾问
      • 更新课程顾问密码
    • 课程管理
      • 创建课程
      • 单次创建直播/实时课堂
      • 查询课程列表
      • 新增课程下发学生
      • 删除课程下发学生
      • 查询课程下发学生列表
      • 下发课程到班级
      • 移除课程班级绑定
      • 查询课程绑定班级IDs
      • 查询课程任务列表
      • 更新课程
      • 查询课程学生
      • 查询学生作业
      • 查询订单详情
    • 校区管理
      • 创建校区
      • 编辑校区
      • 关闭校区
    • 事件推送
      • 事件推送机制
      • 事件推送接入指南
    • 其他接口
      • 三方系统唤起客户端上课方案说明
      • 唤起客户端URL
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐配置
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. 云学堂模块化SDK

云学堂模块化 SDK 概述

云学堂模块化 SDK(YXT SDK)面向需要把伯索云学堂业务页面(实时课堂、作业巩固、资料中心、课程、商城等)嵌入自有 App / PC 应用的机构。与《实时课堂》等功能模块下的 StyleUpime 课堂引擎文档不同:模块化 SDK 以更高层的业务入口封装初始化、Token 登录与页面打开,接入方一般不直接拼课堂 query。

1. 与课堂引擎 SDK 的区别#

项云学堂模块化 SDK(本文)StyleUpime 课堂引擎 SDK
定位嵌入云学堂业务页面(课堂列表、巩固、资料等)以签名 query 启动单次实时课堂 / 微课等
鉴权OpenAPI getToken → 各端写入 Token / PlasoClient服务端签发课堂 query(appType=liveclassSDK 等)
典型入口Android / Harmony YxtSDK;iOS PlasoSDK;PC PlasoClientStyleUpime / PlasoStyleUpimeClient / Electron create*Window
文档目录云学堂模块化SDK/实时课堂/、极速课堂/、微课/ 等功能目录下的各端文档;Electron 安装见 接入基础(Electron & Web)/Electron/
按产品方案选择其一为主路径;需要底层课堂引擎能力时再阅读对应功能模块下的各端文档。

2. 平台能力与限制#

平台支持角色当前对外模块说明
Android老师、助教、学生实时课堂、作业巩固、资料中心等(见《01-Android》)userType 传 teacher / assistant / student
iOS老师、助教、学生实时课堂、作业巩固、资料中心等(见《02-iOS》)userType 传 teacher / assistant / student
Harmony仅学生仅实时课堂、历史课堂不支持老师 / 助教;不提供作业巩固、资料中心、课程、商城等其它业务模块
PC(Web / Electron)老师、助教、学生实时课堂、作业巩固、资料中心等(见《04-PC》)npm @plasosdk/client-sdk;鉴权同 getToken
接入前请按上表核对角色与模块范围,避免在 Harmony 端按 Android / iOS 的完整业务矩阵规划。

3. 平台与 Demo#

平台接入文档对外 Demo / 包当前版本(以仓库或 npm 为准)
Android01-Android.mdYXTSDK-Android-Democn.plaso:yxtsdk:2.0.21
iOS02-iOS.mdYXTSDK-iOS-DemoPlasoFeaturedSDK 0.5.1 等(见文档)
Harmony03-Harmony.mdYXTSDK-Harmony-DemoOHPM yxtsdk 1.0.27
PC04-PC.md@plasosdk/client-sdk3.1.0

4. 共通接入流程#

1.
向伯索申请开放平台 appId、signKey(即 SDK 文档中的 appKey,同一把密钥),并在机构后台准备测试用户 loginName。
2.
宿主集成对应平台 SDK 依赖(移动端声明相机 / 麦克风等权限;PC 按 Web 或 Electron 安装 npm 包)。
3.
业务服务端调用 POST /dataentry/user/getToken 签发访问 Token(客户端勿内置 signKey / appKey)。
4.
移动端:init → updateToken(或 iOS 等价登录)成功后再打开业务页;PC:用 Token 构造 PlasoClient 后 createModule。
5.
Token 失效时登出 / 销毁实例并回到授权流程(Electron 可监听 relaunch)。
开放平台:https://open.plaso.cn/
用户访问 Token:https://open.plaso.cn/api-120430699

5. 阅读建议#

只接 Android:读《01-Android》,并用 Android Demo 联调。
只接 iOS:读《02-iOS》,并用 YXTSDK-iOS-Demo 联调。
只接 Harmony:读《03-Harmony》,确认学生角色与「仅实时课堂 / 历史课堂」范围;必接 Ability 生命周期,并放置 new_zy.html。
只接 PC(Web / Electron 业务页嵌入):读《04-PC》;需要签名 query 进课的课堂引擎时再读《接入基础(Electron & Web)/Electron》与各功能模块下的 Electron 文档。
从外部网页 / App 唤起云学堂客户端:读《05-伯索云学堂跳转接入》。
需要底层板书 / 预解析 / 自有资料中心回调:再转到对应功能模块下的各端文档与《服务端接口与协议》。
修改于 2026-11-17 07:47:57
上一页
播放器 SDK 常见问题
下一页
云学堂模块化 SDK · Android 接入
Built with