伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. 资料中心
  • 产品介绍
    • 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. 资料中心

Web 资料中心接入

0. 版本说明#

项说明
SDK 版本1.68.110(预解析资源回调 ≥ 1.60.116)
依赖plaso_style_upime-1.68.110.js(jssdk)
接入性质可选能力(仅当课堂含以 info 方式插入的资源时需要)
入口PlasoStyleUpime.createLiveClient、getExtFileName、getPreParseFileName
本文只说明 Web 端查看课堂资源的闭环。⚠️ Web SDK 仅支持监课,不能打开资料中心,也不能插入资源,只能查看上课端已插入的内容。监课签名、URL 接入和公共 query 参数见《接入基础(Electron & Web)/Web》;监课启动方式见《实时课堂/Web》;服务端 URL 契约见《服务端接口与协议/04-资料中心与文件URL》。

1. 接入前准备#

需要准备:
与 URL 接入相同的已签名监课 query;
业务服务端根据上课端传入的 info 签发短时 URL 的接口;
当课堂含以 info 方式插入的私有资源或预解析资源时,引入 jssdk 并实现资源回调。
URL 接入能满足大部分监课需求,课堂中以 url 方式插入的资源也可正常显示,此时不必引入 jssdk。不接 jssdk 时,以 info 方式插入的资源将无法显示。

2. 实现资料中心入口#

Web 监课没有资料中心入口,也不提供插入 API。需要查看以 info 方式插入的资源时,用 jssdk 嵌入监课并实现资源回调:
const client = PlasoStyleUpime.createLiveClient(
  document.getElementById('plaso-container'),
  { query: signedMonitorQuery },          // 与 URL 接入相同的已签名监课 query
  {
    getExtFileName: async (info) => api.fetchSignedFileUrl(info),
    getPreParseFileName: async (info, { suffix }) => api.fetchParsedFileUrl(info, suffix),
    onExit: () => { /* SDK 已自动 destroy,这里做页面跳转 */ },
  },
);
api.* 均为业务后端接口,非 SDK API。client.destroy() 会移除 iframe 并解除消息监听,可重复调用;课堂内点击退出触发 onExit 时,SDK 已自动 destroy()。
回调必须满足:
1.
成功时返回完整可访问 URL;
2.
超时、文件不存在、无权限时 reject,不要让 Promise 永久挂起;
3.
不要把 appKey、OSS 私钥或永久下载地址放入前端;
4.
info 为上课端插入时传入的原值,只作为业务文件标识,服务端负责鉴权,并校验监课人员对该课堂资源的访问权限。

3. 非预解析文件接入#

非预解析文件是指 SDK 可以直接加载的 PPT、文档、音频或视频。Web 监课不能插入文件,只按上课端的插入方式显示:
上课端插入方式Web 监课如何查看
urlURL 接入即可正常显示,无需 jssdk
info(私有资源)必须使用 jssdk,并实现 getExtFileName

3.1 使用可直接访问的 URL#

当上课端以 url 方式插入资源(公开可访问或已由业务方预签名、有效期足够的短时 URL)时,Web 监课使用 URL 接入即可显示。SDK 不会调用 getExtFileName。
URL 应使用 HTTPS,且在课堂使用期间保持可访问。

3.2 使用业务文件标识换取 URL#

当上课端以 info 方式插入私有资源时,不要期望 URL 接入能够显示这些文件。需改用 jssdk;SDK 需要加载文件时,会将上课端传入的原始 info 回调给 getExtFileName,由页面向业务服务端换取短时 URL。
getExtFileName: async (info) => api.fetchSignedFileUrl(info),
info 为上课端插入时传入的原值;协议见《服务端接口与协议/04-资料中心与文件URL》;
成功返回完整 URL;失败 reject,不要让 Promise 永久挂起;
🔒 服务端校验监课人员对该课堂资源的访问权限,不在前端保存 OSS 永久密钥。

4. 预解析文件接入#

预解析文件是业务服务端已完成转换的 PPT、PDF、Word 或 Excel。上课端插入的不是文件 URL,而是解析文件 ID;SDK 按需通过 getPreParseFileName 请求每个解析产物的短时 URL。Web 监课不能插入预解析文件,只能在上课端已以 info 方式插入后查看。
完整流程:
1.
业务服务端上传原始文件、创建解析任务,并在完成后保存解析文件 ID、类型、产物目录和页数。
2.
上课端将解析文件 ID 以 info 方式插入课堂。
3.
Web 监课使用 jssdk 进入,并实现 getPreParseFileName。
4.
SDK 回调 getPreParseFileName(info, { suffix }) 请求页面或资源。
5.
页面将解析文件 ID 和原始 suffix 提交业务服务端,服务端鉴权后返回该产物的短时 URL。

4.1 插入预解析文件#

Web SDK 不提供插入能力。预解析文件由上课端插入,且必须使用 info(而不是可直接访问的 url),Web 监课才能通过回调换取产物 URL。info 为上课端插入时传入的原值,回调中原样回传。

4.2 预解析资源 URL 回调#

当 SDK 需要加载预解析文件的某一页、HTML 页面或元数据时,会调用:
getPreParseFileName: async (info, { suffix }) => api.fetchParsedFileUrl(info, suffix),
参数使用方式
info上课端插入时传入的原始对象,可从中取出解析文件 ID。
suffixSDK 请求的解析产物相对路径,例如 /index.html、/info.json、/1.jpg。原样提交业务服务端。每个 suffix 调用一次,同一文件会多次调用。
返回值成功时返回完整的短时 URL;任何失败场景 reject。不要让 Promise 永久挂起。
该回调不是创建解析任务的入口,也不是前端拼接 OSS 地址的位置。前端只负责提取解析文件 ID,并把 fileId + suffix 请求业务服务端;服务端负责鉴权、校验 suffix、定位解析产物和签发 URL。
解析任务、回调和 URL 签发接口的详细约定见《服务端接口与协议/05-文档预解析》。当前没有独立的 Web 文件预解析文档。

5. 和直播课堂、监课的关系#

实时课堂 / 极速课堂监课:以 url 方式插入的资源用 URL 接入即可查看;以 info 方式插入的私有资源或预解析资源需改用 jssdk,并实现 getExtFileName / getPreParseFileName,见 实时课堂/Web;
微课:Web SDK 不提供微课,也不能插入资源;
历史课堂:以 info 方式插入的资源需要播放器 SDK jssdk 重新实现资源回调;以 url 方式插入的资源无需回调,见 历史课堂回放/播放器。

6. 联调检查清单#

以 url 方式插入的资源在 URL 接入下能直接显示。
课堂含以 info 方式插入的私有资源时,已改用 jssdk,getExtFileName 能返回短时 URL。
课堂含预解析资源时,已实现 getPreParseFileName,能按 suffix 返回短时 URL;异常时 reject。
info 为上课端插入时的原值;失败时 Promise 会 reject,不会永久挂起。
URL 失败时 SDK 能结束等待并显示失败。
业务服务端校验了监课人员的访问权限,没有把永久密钥下发到前端。
退出监课时 onExit 触发,SDK 已自动 destroy();也可再次调用 client.destroy()。
修改于 2026-11-17 07:47:57
上一页
Electron 资料中心接入
下一页
Android 文件预解析接入
Built with