伯索开放平台
首页
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. 资料中心

Harmony 资料中心接入

Harmony SDK 的资料中心由业务 App 实现 IResourceProvider。该能力可用于实时课堂和极速课堂。

0. 接入前准备#

需要准备自有资料中心页面、业务文件 ID、由业务服务端返回可访问完整 URL 的接口,以及已注册的 IResourceProvider。课堂基础初始化见《实时课堂/Harmony》;服务端 URL 契约见《服务端接口与协议/04-资料中心与文件URL》。私有资源 URL 的有效期由业务方按安全策略决定,并非 SDK 回调协议的强制要求。

1. 实现资料中心入口#

supportResourceCenter(): boolean { return true; }
showResourceCenter(_checkAi: boolean): void {
  // 打开业务资料中心页面。
}
dismissResourceCenter(): void {
  // 关闭业务资料中心页面。
}
在进入课堂前通过 StyleUpime.getInstance().setResourceProvider(provider) 注册 Provider。若不支持资料中心则返回 false;所有失败分支必须调用 callback.onFilePath(null)。

2. 非预解析文件接入#

非预解析文件是 SDK 可直接加载的 PPT、文档、音频或视频。资料中心选中文件后调用 PlasoUpimeBoard.getInstance().insertObject。根据 info 是公开 URL 还是业务文件标识,分别走以下两条路径。
import { PlasoUpimeBoard, UpimeObject } from 'styleupime';

PlasoUpimeBoard.getInstance().insertObject(UpimeObject.TYPE_PDF, info, title);
info 类型支持类型行为
stringTYPE_PPT、TYPE_DOC、TYPE_XLS、TYPE_PDF、TYPE_AUDIO、TYPE_VIDEO必须是可直接访问的 HTTP URL;SDK 直接插入。
List推荐音视频SDK 调用 getExtFileName;业务端返回授权后的可访问完整 URL。
getExtFileName(info: Object | null, callback: IResourceCallback): void {
  requestFileUrl(info)
    .then((url: string) => callback.onFilePath(url))
    .catch(() => callback.onFilePath(null));
}
info 应为业务文件标识。服务端须校验访问权限并返回可访问的完整 URL,不允许客户端拼接对象存储路径或信任任意外部 URL。

2.1 非预解析公开文件:直接插入 URL#

公开文件或已提前签发、且有效期覆盖课堂使用时长的 URL,可直接以 URL 字符串作为 info:
PlasoUpimeBoard.getInstance().insertObject(
  UpimeObject.TYPE_PDF,
  'https://cdn.example.com/courseware/chapter-1.pdf',
  '第一章.pdf'
);
SDK 不会调用 getExtFileName。URL 应使用 HTTPS 且在课堂期间可访问。

2.2 非预解析私有文件:回调换取 URL#

私有文件传入稳定的业务标识,例如 ['file', { id: fileId }],由 getExtFileName 换取 URL:
getExtFileName(info: Object | null, callback: IResourceCallback): void {
  const fileId = extractFileId(info);
  if (!fileId) {
    callback.onFilePath(null);
    return;
  }

  requestFileUrl(fileId)
    .then((url: string) => callback.onFilePath(url || null))
    .catch(() => callback.onFilePath(null));
}
每次请求只能完成一次回调。超时、文件不存在、无权限或服务端返回空 URL 时均回调 null;不能在客户端保存 appKey、对象存储私钥或永久下载地址。

3. 预解析文件接入#

预解析文件是业务服务端已完成转换的 PPT、PDF、Word 或 Excel。资料中心插入的是解析文件 ID,而非文件 URL;SDK 按需调用 getPreParseFileName 请求每个解析产物的可访问完整 URL。
预解析文件的 info 必须为 List,类型可为 TYPE_I_SPRING_PPT、TYPE_DOC、TYPE_XLS、TYPE_PDF。SDK 会调用:
getPreParseFileName(
  info: Object | null, suffix: string | null, callback: IResourceCallback
): void {
  requestParsedFileUrl(info, suffix)
    .then((url: string) => callback.onFilePath(url))
    .catch(() => callback.onFilePath(null));
}
suffix 常见为 /1.jpg、/index.html、/ispring.html、/info.json。预解析任务、文件类型和服务端校验规则见《文件预解析/Harmony》。

3.1 插入预解析文件#

资料中心仅应返回已完成解析的文件 ID、类型、标题和页数。推荐 info 格式为 ['parsed', { id: 'parsed-file-001' }]。Harmony SDK 的插入方法可传入页数:
const parsedInfo: Object[] = ['parsed', { id: 'parsed-file-001' }];
PlasoUpimeBoard.getInstance().insertObject(
  UpimeObject.TYPE_PDF,
  parsedInfo,
  '课件.pdf',
  12
);
文件类型type额外参数常见 suffix
iSpring PPTTYPE_I_SPRING_PPT不传页数/index.html、/ispring.html
PDFTYPE_PDF传解析总页数/1.jpg、/info.json
WordTYPE_DOC传解析总页数/1.jpg、/info.json
ExcelTYPE_XLS传解析总页数/1.jpg、/info.json

3.2 预解析资源 URL 回调#

getPreParseFileName 的 info 是插入时的原始对象,suffix 是 SDK 请求的解析产物相对路径。客户端只提取文件 ID 后将 fileId + suffix 提交给业务服务端;服务端鉴权、校验 suffix、定位产物并返回可访问完整 URL。
getPreParseFileName(
  info: Object | null,
  suffix: string | null,
  callback: IResourceCallback
): void {
  const fileId = extractFileId(info);
  if (!fileId || !suffix) {
    callback.onFilePath(null);
    return;
  }

  requestParsedFileUrl(fileId, suffix)
    .then((url: string) => callback.onFilePath(url || null))
    .catch(() => callback.onFilePath(null));
}
服务端必须拒绝目录穿越、反斜杠、绝对路径、完整 URL、非当前解析任务的资源及非法 suffix。suffix 可能含图片处理查询参数,客户端应完整编码传递,服务端解码并校验后再签发 URL。

4. 窗口与图片打开模式#

使用 OPEN_FILE_MODE_WINDOW 时,SDK 按需请求 HTML、页面图片和元数据。使用 OPEN_FILE_MODE_IMAGE 时,PDF、Word、Excel 可能以 suffix == "?" 请求原始文件 URL;业务服务端应按已校验的文件 ID 返回可访问的完整原始文件 URL,不能把 ? 拼入解析产物路径。

5. 联调检查#

supportResourceCenter() 返回 true 时课堂可显示入口,且能正确关闭资料中心。
公开文件可直接加载;私有文件会触发 getExtFileName 并返回可访问的完整 URL。
预解析对象使用正确的类型、文件 ID 和 PDF/Word/Excel 页数。
每个 getPreParseFileName 请求均能按完整 suffix 返回可访问的完整 URL,失败时仅回调一次 null。
客户端未暴露永久 URL、对象存储凭证、appKey 或解析产物路径。
修改于 2026-11-17 07:47:57
上一页
Android 资料中心接入
下一页
iOS 资料中心接入
Built with