伯索开放平台
首页
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 · Harmony 接入

第三方 App 依赖一个 OHPM 包 yxtsdk,完成初始化、写入 Token 后即可打开实时课堂(含历史课堂入口)。对照对外 Demo:YXTSDK-Harmony-Demo。
项说明
OHPM 包名yxtsdk
当前版本1.0.27(以 Demo 为准)
API 入口YxtSDK
开发环境HarmonyOS API 12+ / SDK 5.0.0(12)+,DevEco Studio

1. 添加依赖#

工程根目录 .ohpmrc(仅拉取,不要放 publish 密钥):
在 entry/oh-package.json5:
{
  "dependencies": {
    "yxtsdk": "1.0.27"
  }
}
然后 Sync Project / ohpm install。进原生课建议真机。

使用对外 Demo 验证#

1.
克隆 YXTSDK-Harmony-Demo。
2.
DevEco 打开仓库,确认 "yxtsdk": "1.0.27" 与 .ohpmrc。
3.
配置签名(Demo 包名 com.plaso.sdkdemo),填写公司 appId / signKey(即课堂 SDK 中的 appKey,同一把密钥)登录后进课。
Demo 中 entry/src/main/ets/auth/ 仅为取 Token 工具,不会打进 yxtsdk HAR;正式环境请换成业务服务端签发 Token。

2. Ability 生命周期(必接)#

课堂模块依赖 Ability / WindowStage。请在宿主 UIAbility 中统一转发到 YxtSDK:
init 会按 HAR 默认环境覆盖一次,因此 setServerEnv 请放在 init 之后。漏接 onWindowStageCreate 可能导致竖屏、白底、状态栏仍可见。

3. 权限#

在 module.json5 中声明:
ohos.permission.INTERNET
ohos.permission.CAMERA
ohos.permission.MICROPHONE
进课前按系统要求动态申请相机 / 麦克风。

4. Token 与打开实时课堂#

Token 由业务服务端获取(OpenAPI getToken,流程同 Android / iOS 文档),客户端不要把 signKey 写进 App。调用顺序:init 成功 → updateToken 成功 → 打开课堂。

4.1 全屏打开课堂#

打开合并页(实时课堂 + 历史课堂):
退出登录:YxtSDK.doLogout()。

4.2 嵌入页面打开课堂#

在自有页面中嵌入合并页(需放在 @Builder 中):
YxtSdkLiveClassOptions:
字段说明
initialTab初始 Tab,默认实时课堂

4.3 常见错误码#

码含义
10001初始化失败
10002Token 为空
10003机构标识无效
10004未初始化
10005updateToken 失败

5. 进课横竖说明#

进入原生实时课后,SDK 会:
手机强制横屏
隐藏全屏导航状态栏 / 导航栏
前提是已调用 YxtSDK.onWindowStageCreate。漏接可能导致竖屏、白底、状态栏仍可见。

6. 本地 H5 壳页 new_zy.html#

6.1 作用#

new_zy.html 是课堂相关本地 H5 壳页,由 WebView 加载后再按环境拉取远端 js/all.js 等资源。用于:
历史课堂 / 回放
极速直播等 Web 课堂场景
教材中心等课内 WebView(如 file://…/new_zy.html?…)
壳页本身不承载业务 UI,只负责解析 URL 参数(如 dhost、rhost、initjs)、展示加载态,并动态引入远端脚本。

6.2 接入默认:拷贝到宿主 resfile(必做)#

鸿蒙 HAR 包内的 resfile / rawfile 不会自动合并进宿主 HAP。当前发行阶段,正式接入默认要求把壳页拷进宿主工程(与 Android 放 assets 一致),不要依赖「只引 HAR、不拷文件」。
Demo 已放置:
entry/src/main/resources/resfile/new_zy.html
请复制到宿主同路径;历史课 / 极速直播 / 教材等场景均以宿主 resfile 为准。

6.3 接入要求#

1.
必做:从 Demo 复制 entry/src/main/resources/resfile/new_zy.html 到宿主同路径(模块名/src/main/resources/resfile/new_zy.html)。
2.
不要改文件名;业务侧一般无需手动 loadUrl,由 SDK 在历史课 / 教材 WebView 等场景自动加载。
3.
正常走 YxtSDK.init 即可;无需额外调用抽出逻辑。
4.
壳页依赖网络加载远端 JS;加载超时约 30 秒会显示「网络故障,刷新试试哦~」,可点刷新重试。
5.
请保持与当前 yxtsdk 发行包配套的壳页版本;随意替换或删减可能导致历史课 / 教材页白屏。

7. 联调检查清单#

已声明 yxtsdk 1.0.27,.ohpmrc 可拉取。
Ability 四个生命周期均转发到 YxtSDK。
相机 / 麦克风权限已申请。
宿主已放置 resources/resfile/new_zy.html(必做)。
init → updateToken 成功后再 startLiveClass 或嵌入 YxtSdkGetLiveClassHomePage。
真机进课可横屏全屏;历史课堂 / 回放可打开。
正式包未内置 signKey。
修改于 2026-11-17 07:40:26
上一页
云学堂模块化 SDK · iOS 接入
下一页
云学堂模块化 SDK · PC 接入
Built with