伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. 服务端接口与协议
  • 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 接入
    • 伯索云学堂跳转接入
  • 接入基础(Electron & Web)
    • Web
      • Web 概述
      • Web 快速开始:URL 接入监课
      • Web 初始化与配置(监课)
      • Web API 参考(监课)
      • Web 事件与回调(监课)
      • Web 错误码(监课)
      • Web 常见问题(监课)
    • Electron
      • Electron 概述
      • Electron 快速开始
      • Electron 初始化与配置
      • Electron API 参考
      • Electron 事件与回调
      • Electron 错误码
      • Electron 常见问题
  • 服务端接口与协议
    • 服务端接口与协议阅读顺序
    • 签名与鉴权
    • 签名示例
    • query 参数
    • 资料中心与文件 URL
    • 文档预解析
    • 课堂进行中数据回调
    • 课堂结束数据回调
    • 历史课堂转视频与下载
  1. 服务端接口与协议

服务端接口与协议阅读顺序

本目录是跨端协议和服务端接口的规范库。端侧开发者通常不需要从头通读,只有后端开发、联调负责人或排查问题时需要按场景阅读。

推荐阅读顺序#

顺序文档什么时候读
1签名与鉴权所有接入都必须先确认签名方式、密钥保存和验签规则
2签名示例需要对照预期签名,或用 Go、Java、Node.js、PHP 实现签名时阅读
3query 参数启动实时课堂、播放器 SDK 前阅读
4资料中心与文件 URL接入自有资料中心、插入私有文件、历史课堂回放需重新取文件 URL 时阅读
5文档预解析接入 PPT/PDF/Word/Excel 预解析课件时阅读
6课堂进行中数据回调需要接收课堂延时/提前结束,或录制开始后的课堂出勤回调时阅读
7课堂结束数据回调需要接收课后课堂数据、recordId、统计数据和聊天消息时阅读
8历史课堂转视频与下载需要把历史课堂或微课通过平台 API 导出为视频时阅读

与端文档的关系#

Android、iOS、Electron、Web SDK、播放器 SDK 与云学堂模块化 SDK 文档负责讲清各自流程。
本目录负责给出跨端一致的字段、协议、安全边界、回调和错误处理规则。
如果端文档与本目录字段定义冲突,以本目录为准;如果本目录与 SDK 实际行为冲突,应以 SDK 当前版本和联调结果修正文档。
修改于 2026-11-18 04:00:59
上一页
Electron 常见问题
下一页
签名与鉴权
Built with