伯索开放平台
首页
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. 服务端接口与协议

签名与鉴权

本文是 SDK 接入的签名权威说明。各端文档只保留本端如何获取已签 query 的流程,全量签名规则以本文为准。可核对的进房参数,以及 Go、Java、Node.js、PHP 实现,见《签名示例》。

1. 基本原则#

伯索云学堂使用 appId + appKey + HMAC-SHA1 签名校验请求来源和参数完整性。
appKey 与 Open API / 部分文档中的 signKey 是同一把密钥(移动端 Demo 习惯与 appId 成对写作 appKey)。详见《关键概念》。
正式环境中,该密钥必须只保存在客户服务端。Android、iOS、Electron、Web 前端不应直接持有或计算正式签名。端侧应向客户服务端请求已签名的 query 或业务接口参数。

2. 签名字段#

字段类型必填说明
appIdstring是伯索分配的应用标识
validBeginnumber是签名生效时间,Unix 秒级时间戳,必须为整数
validTimenumber是有效时长,单位秒
signaturestring是HMAC-SHA1 计算结果,Hex 大写
业务参数根据具体接口或 query 场景追加。参与签名的参数不包含 signature 本身。

3. 生成规则#

1.
准备所有参与签名的参数,包含 appId、validBegin、validTime 和业务参数。
2.
移除 signature。该字段不参与计算。
3.
将其余参数名按 UTF-8 字节升序排序。参数名都是 ASCII 时,结果与字母表升序相同。
4.
把每个值转成文本。字符串使用原文;整数写成十进制;布尔写成 true 或 false;空值写成空字符串。对象和数组按 Go encoding/json 序列化。不要先做 URL 编码。
5.
按 key=value 拼接,参数之间用 & 连接。
6.
使用 appKey 对这条原文做 HMAC-SHA1。
7.
把 20 字节摘要编码为 40 位大写十六进制,作为 signature。
8.
把 signature 加回参数。组成 query 或 URL 时,再对传输中的参数值做 URL 编码。
进房参数的签名原文如下。密钥 202611131865 对应的签名是 6705EA6C8CF205CAA23718EB25CE36422596CBEB。query 里的 userName=%E8%80%81%E5%B8%881 只是传输编码,签名使用解码后的 老师1。
appId=1865&appType=liveclassSDK&d_dimension=1280x720&env=dev&loginName=t1&mediaType=video&meetingId=20261113&meetingType=public&openFileMode=1&userName=老师1&userType=speaker&validBegin=1794553258&validTime=10800&vendorType=2&videoStream=2
字段表和各语言代码见《签名示例》。

4. 服务端接口建议#

客户服务端建议提供一个内部接口,例如:
请求体由端侧提交课堂业务参数,服务端补充或校验:
appId
validBegin
validTime
用户身份与角色权限
课堂 ID 是否属于当前机构
服务端返回已签 query:
{
  "query": "appId=plaso&appType=liveclassSDK&...&signature=XXXX",
  "expireAt": 1703123756
}

5. 验签失败处理#

服务端或回调接收方应拒绝以下请求:
缺少 appId、validBegin、validTime 或 signature。
validBegin、validTime 不是整数秒。
当前时间不在 validBegin + validTime 有效窗口内。
重新计算的签名与请求签名不一致。
appId 找不到对应密钥。
公开回调接口验签失败时应返回明确的 HTTP 状态和业务错误,并按具体回调文档约定决定是否触发重试。

6. 常见错误#

错误影响建议
使用 appid与规范字段不一致,验签失败统一使用 appId
把 appKey 与 signKey 当成两把密钥对接时反复确认「到底用哪把」二者同一把;按文档字段名选用即可
Date.now()/1000 未取整出现浮点秒,签名不稳定使用整数秒
Android BigInteger(...).toString(16)可能丢失前导零Hex 输出必须补齐 40 位
客户端保存 appKey / signKey密钥泄露风险正式环境只允许服务端签名
签名前 URL encode与服务端签名原文不一致签名使用原文,组 query 时再编码
参数名未按 UTF-8 字节序排序参数名含非 ASCII 字符时验签失败按 UTF-8 字节升序排序
对象或数组使用语言默认字符串与 encoding/json 结果不一致对象和数组按 Go encoding/json 序列化
修改于 2026-11-17 07:47:57
上一页
服务端接口与协议阅读顺序
下一页
签名示例
Built with