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

本文说明如何将伯索云学堂 PC 端模块化 SDK 接入自有 Web 或 Electron 应用。公开模块包括作业、课堂列表、资料中心。npm 包与完整 README:@plasosdk/client-sdk(当前文档按 3.1.0 整理)。
与《接入基础(Electron & Web)/Electron》及各功能模块下的 Electron 课堂引擎(@plasosdk/plaso-electron-sdk,签名 query 进课)不同:本包以用户访问 Token 打开云学堂业务页,不直接拼课堂 query。
开放平台:https://open.plaso.cn/ · 用户访问 Token:https://open.plaso.cn/api-120430699

1. 快速接入#

要求值
运行环境现代浏览器(Web),或 Electron(需 @electron/remote)
npm 包@plasosdk/client-sdk(建议 3.1.0 及以上)
入口渲染进程:PlasoClient;Electron 主进程:@plasosdk/client-sdk/electron 的 init
鉴权OpenAPI getToken 签发的访问 Token

1.1 安装#

@plasosdk/plaso-electron-sdk 与 electron-store 已作为本包依赖随安装带上,宿主不必再单独安装。
Electron 宿主还需安装 peer 依赖(须与宿主共用同一实例;纯 Web 可跳过):
若需要录音后的音频转换(WAV→MP3),由宿主自行安装并在主进程 init() 时显式传入(开发与打包一律如此):
使用 electron-builder 打包时,需按 npm README 中的「Electron Builder 打包特别说明」调整配置,以适配随包依赖的 @plasosdk/plaso-electron-sdk 原生二进制。

1.2 特点摘要#

原生 DOM 实现,无 React / Vue 依赖,不与宿主框架版本冲突。
提供 DOM 容器与有效 Token 即可渲染;Web 用 iframe 嵌入容器,Electron 下各模块以独立窗口打开。
支持作业(NHOMEWORK)、课堂(LIVECLASS)、资源(RESOURCES)。

2. 申请凭证与 Token#

与 Android / iOS / Harmony 模块化 SDK 相同:
1.
向伯索申请 appId、signKey(即 SDK 文档中的 appKey,同一把密钥),在机构后台准备 loginName。
2.
业务服务端调用 POST https://{host}/dataentry/user/getToken 签发 Token(客户端勿内置 signKey / appKey)。
3.
userType 与角色一致:student / teacher / assistant。
签名字段、排序与 HmacSHA1 规则见《01-Android》第 4 节或开放平台 Token 文档。成功时取 obj.token 交给 PlasoClient。

3. Web 接入(渲染侧)#

容器需有明确宽高。同一个 PlasoClient 实例重复创建模块时,会先销毁上一个再创建新的。

3.1 构造参数#

参数类型必填说明
tokenstring是开放平台用户访问 Token
containerHTMLElement是渲染容器;Web / Electron 均必填(Electron 下页面不嵌入该容器,见第 5 节)
platformstring否'plaso'(默认)或 'ai';非法值不会抛错,但会拼出无效域名导致静默失败
envEnvironment否默认 PROD,可不传
onError(error: Error) => void否错误回调
onLoading(isLoading: boolean) => void否加载状态回调
devToolsboolean否是否打开开发者工具,默认 false

3.2 模块类型#

枚举值说明
PlasoContentType.NHOMEWORKnhomework作业
PlasoContentType.LIVECLASSliveclass课堂(列表 / 进课)
PlasoContentType.RESOURCESresources资料中心

3.3 销毁与容器复用#

destroy() 会用同属性空节点替换构造时传入的 container,原节点已脱离 DOM。若还要再建实例,必须使用返回值:
Electron 下 destroy() 还会请求关闭已打开的模块独立窗口(课堂进行中时,课堂列表窗口关闭会被拦截,见第 5 节)。

4. Electron 主进程#

主进程必须先 init,且创建宿主 BrowserWindow 时开启 SDK 硬性要求的三项偏好:
init(remoteMain, ffmpegModule?, ffmpegPath?) 返回 EventEmitter。后两个参数在类型上可选,但若要用音频转换,开发与打包都应显式传入;不要依赖 SDK 内部 require 兜底(打包后路径常失效)。成功加载时可在主进程日志中看到 FFmpeg loaded successfully from external modules。
当前对外事件:
事件参数时机
relaunchargs: string[](process.argv)页面侧请求重启宿主(如 Token 过期)
渲染进程用法与第 3 节相同(new PlasoClient + createModule)。

5. Electron 独立窗口说明#

在 Electron 环境下,createModule() 不把页面嵌进传入的 container,而是按模块类型打开独立窗口(同类型单例:重复创建会聚焦已有窗口;不同类型可同时开)。
原因(课堂列表):从列表进课后,课堂窗口的通信桥依赖列表页存活;若列表嵌在宿主容器内、宿主销毁容器,课堂窗会变「孤儿」,板书保存、资料中心、下课通知等会失效。因此:
课堂列表窗口的关闭由 SDK 接管:课堂进行中时关闭会被阻止,并提示先退出进行中的课堂。
作业、资料中心对齐独立窗口形态;二者关闭不拦截。
纯浏览器行为不变:仍以 iframe 嵌入 container。

6. 与课堂引擎 Electron SDK 的选型#

项PC 模块化 SDK(本文)Electron 课堂引擎 SDK
包名@plasosdk/client-sdk@plasosdk/plaso-electron-sdk(亦可被本包间接依赖)
典型目标嵌入云学堂作业 / 课堂列表 / 资料中心业务页用签名 query 直接拉起单次实时课堂 / 微课等
鉴权getToken → PlasoClient({ token })服务端签发课堂 query
文档本文接入基础(Electron & Web)/Electron/
需要完整课堂引擎能力(自有资料中心回调、预解析、极速课堂参数等)时,阅读《接入基础(Electron & Web)/Electron》与各功能模块下的 Electron 文档;只需业务页嵌入时用本包即可。

7. 联调检查清单#

已安装 @plasosdk/client-sdk;Electron 另装 @electron/remote,音频转换按需装 fluent-ffmpeg / ffmpeg-static。
服务端 getToken 验签通过,Token 未过期。
Web:容器有宽高,createModule / 快捷方法可打开作业、课堂、资源。
Electron:主进程已 init;BrowserWindow 开启 webviewTag、nodeIntegration、contextIsolation: false;已 remoteMain.enable。
Electron:课堂列表进课后,关闭列表窗时进行中课堂会拦截;destroy() 复用容器时使用了返回值。
正式环境未在前端内置 signKey;platform 与业务域名一致。
electron-builder 打包配置已按 npm README 适配原生依赖。
修改于 2026-11-17 07:47:57
上一页
云学堂模块化 SDK · Harmony 接入
下一页
伯索云学堂跳转接入
Built with