伯索开放平台
首页
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 支持在实时课堂和极速课堂中插入已预解析的 PPT、PDF、Word、Excel。业务服务端负责创建解析任务、保存解析完成回调,并在 SDK 请求解析产物时返回可访问的完整 URL。私有资源 URL 的有效期由业务方按安全策略决定,并非 SDK 回调协议的强制要求。

1. 接入流程#

1.
服务端调用文档预解析服务并保存解析文件 ID、状态、页数和产物信息。
2.
资料中心将预解析 ID 以 List 类型 info 插入课堂。
3.
SDK 调用 getPreParseFileName(info, suffix, callback)。
4.
App 将 info、suffix 发给业务服务端,服务端验证后返回对应产物的可访问完整 URL。
5.
App 每次请求均调用一次 callback.onFilePath(url);失败时传入 null。
完整服务端 API 和回调见《服务端接口与协议/05-文档预解析》。

2. 服务端解析链路#

Harmony 客户端不直接调用文档解析服务,也不直接拼接或访问解析产物目录。业务服务端应维护解析记录:
字段用途
fileId业务文件 ID;资料中心与客户端 info 使用的稳定标识。
sourcePath原始文件的对象存储路径;仅服务端用于创建任务。
taskId伯索解析任务 ID,用于关联异步回调。
status至少包含 PENDING、COMPLETED、FAILED。
targetPath解析产物目录;仅保存在服务端。
totalPagesPDF、Word、Excel 的解析页数。
fileType原始文件类型,用于映射 SDK type。
创建任务时,业务服务端上传原始文件、创建 PENDING 记录,并调用:
POST https://www.plaso.cn/dataentry/document/parser
请求应按服务端协议包含 appId、sourcePath、taskType、callbackUrl、validBegin、validTime 和 signature;任务类型为 PPT 4、Word/Excel 5、PDF 8。成功后保存返回的 taskId。
解析服务回调 callbackUrl 时,服务端必须按 taskId 幂等处理:taskStatus=100 更新为 COMPLETED 并保存 targetPath、convertPages;taskStatus=101 更新为 FAILED 并保存失败原因。资料中心仅展示 COMPLETED 的文件。

3. 签发解析产物 URL#

业务服务端应提供接收 fileId + suffix 的接口,例如:
GET /api/files/{fileId}/parsed-url?suffix=<url-encoded-suffix>
处理顺序必须为:
1.
查询解析记录并校验当前用户访问权限;
2.
确认状态为 COMPLETED,且存在 targetPath;
3.
对 suffix 做规范化和白名单校验,拒绝 ..、反斜杠、绝对路径、完整 URL 和不属于当前任务的产物;
4.
仅在服务端组合受校验的 targetPath + suffix,返回可访问的完整 URL;
5.
失败返回业务错误,客户端回调 onFilePath(null)。
suffix 可为 /1.jpg、/index.html、/ispring.html、/info.json,也可能含图片处理查询参数。客户端不得收到 targetPath、OSS 长期凭证或对象存储路径规则。

4. 预解析文件对象与插入#

文件类型常见 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

4.1 预解析 PPT#

预解析 PPT 使用 TYPE_I_SPRING_PPT,不传解析页数。SDK 会按需请求 HTML 入口和运行页;每次回调均使用同一个解析文件 ID 换取当前 suffix 的可访问完整 URL。
PlasoUpimeBoard.getInstance().insertObject(
  UpimeObject.TYPE_I_SPRING_PPT,
  ['parsed', { id: 'parsed-ppt-001' }],
  '课件.pptx'
);
典型请求顺序为:

4.2 预解析 PDF、Word 和 Excel#

PDF、Word、Excel 分别使用 TYPE_PDF、TYPE_DOC、TYPE_XLS,并且必须传入解析总页数;否则 SDK 无法正确构建分页资源。
PlasoUpimeBoard.getInstance().insertObject(
  UpimeObject.TYPE_PDF,
  info,
  '示例课件',
  totalPages
);
SDK 会按页和元数据多次请求资源:
suffix用途
/1.jpg、/2.jpgPDF/文档解析页图片。
/info.json解析文件元数据。
/1.jpg?x-oss-process=...带图片处理参数的解析页;查询参数也是 suffix 的一部分。

5. 客户端回调#

getPreParseFileName 不是创建解析任务的入口,也不是客户端拼接 OSS 地址的位置。每次 SDK 请求都要将 info 中的业务文件 ID 与原始 suffix 发送到业务服务端,并且每次只完成一次回调:
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));
}

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

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

7. 联调检查#

解析任务已关联业务 fileId 与 taskId,回调按 taskId 幂等落库。
资料中心只返回 COMPLETED 的预解析文件,且包含正确页数。
PPT、PDF、Word、Excel 使用正确的 type;后 3 类传入总页数。
服务端为每个 fileId + suffix 请求进行鉴权、白名单校验并返回可访问的完整 URL。
解析未完成、无权限、产物不存在、网络超时和非法 suffix 均快速回调 null。
资料中心注册和普通文件处理见《资料中心/Harmony》。
修改于 2026-11-17 07:47:57
上一页
Android 文件预解析接入
下一页
iOS 文件预解析接入
Built with