伯索开放平台
首页
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 接入
      • 伯索云学堂跳转接入
    • 接入基础(Electron & Web)
      • Web
        • Web 概述
        • Web 快速开始:URL 接入监课
        • Web 初始化与配置(监课)
        • Web API 参考(监课)
        • Web 事件与回调(监课)
        • Web 错误码(监课)
        • Web 常见问题(监课)
      • Electron
        • Electron 概述
        • Electron 快速开始
        • Electron 初始化与配置
        • Electron API 参考
        • Electron 事件与回调
        • Electron 错误码
        • Electron 常见问题
    • 服务端接口与协议
      • 服务端接口与协议阅读顺序
      • 签名与鉴权
      • 签名示例
      • query 参数
      • 资料中心与文件 URL
      • 文档预解析
      • 课堂进行中数据回调
      • 课堂结束数据回调
      • 历史课堂转视频与下载
  • Open API
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
      • 恢复删除的用户
      • 设置学生属性(是否跟随/是否加联/分配课程顾问)
      • 学生随机分配课程顾问(V2)
      • 根据ids,批量查询用户
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
      • 批量绑定老师到班级
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 查询课堂下历史课堂信息
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
      • 获取课堂中引用的课件列表
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
      • 获取学生课程统计数据
      • 获取学生课程详情统计数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
    • 积分管理
      • 机构积分规则
      • 查下学生当前积分数
      • 查下机构每天的积分明细记录
    • 课程顾问
      • 新建课程顾问
      • 编辑课程顾问
      • 查询课程顾问
      • 停用/启用课程顾问
      • 更新课程顾问密码
    • 课程管理
      • 创建课程
      • 单次创建直播/实时课堂
      • 查询课程列表
      • 新增课程下发学生
      • 删除课程下发学生
      • 查询课程下发学生列表
      • 下发课程到班级
      • 移除课程班级绑定
      • 查询课程绑定班级IDs
      • 查询课程任务列表
      • 更新课程
      • 查询课程学生
      • 查询学生作业
      • 查询订单详情
    • 校区管理
      • 创建校区
      • 编辑校区
      • 关闭校区
    • 事件推送
      • 事件推送机制
      • 事件推送接入指南
    • 其他接口
      • 三方系统唤起客户端上课方案说明
      • 唤起客户端URL
    • 资源管理
      • 老师资料上传凭证
      • 创建老师资料目录
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐配置
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. 接入须知

调用流程

申请加入#

机构需要提前发起申请,开放平台审核通过后,会给开发者分配唯一标识(appId)和授权秘钥(signKey)。
有些接口是需要扣费的,请机构妥善使用。建议先在开发环境下完成业务联调测试,再部署到正式环境。
注:参数签名,需要在学校系统服务器上进行,防止秘钥泄露。

协议须知#

调用方在集成通用API时,请遵循以下规则。
规则描述
传输方式HTTPS
接口域名https://www.plaso.cn
请求方式POST
字符编码统一使用UTF-8编码
响应格式统一采用application/json
部分接口协议有特殊要求。如无特别说明,遵循这里的统一规则

接口签名验证#

API接口需要签名验证,接口传递除定义的业务参数外,还需要统一增加签名验证参数:
名称类型定义
appIdString申请的appId参数
validBeginNumber请求开始生效起始时间(单位秒) 1970至开始的秒数
validTimeNumber请求有效时间段,单位秒
signatureString需要计算得出的签名值,服务端会比对验证URL合法性
签名过程是将业务参数以 参数名称=参数值 的形式按照 参数名称 的字⺟表升序排序,并⽤ & 拼接,然后⽤ HMAC-sha1 签名并以 Hex 格式输出 signature 值,再把 signature 和 API 的其他上传参数一起提交到开放平台。
js示例代码:
java示例代码:

输出结果#

接口返回结果的格式(JSON 格式体,utf8 编码格式),具体说明如下:
名称类型描述
codeNumber接口返回状态码
messageString错误状态下提示信息
objObject接口处理后,返回的对象。 具体见各接口内详细定义
返回示例
{
    "code": 0,
    "message": "",
    "obj": {}
}

KA 接口请求与签名#

为了简化签名的复杂性,路径中含 /ka/ 的接口使用同一套请求头签名。

请求头#

Header签名参数名含义
X-AppIdappid合作方 appId,
X-TimestamptimestampUnix 时间戳,单位秒
X-Noncenonce随机串。本服务生成时为 8 字节随机数的 16 位十六进制
X-SignsignHMAC-SHA1 结果,40 位十六进制
四个头都必填。其它头(如 Content-Type、User-Agent)不参与签名。

签名#

待签字符串只含 appid、nonce、timestamp。sign 自身不参与。
1.
按参数名 ASCII 升序排列。三个参数的固定顺序是 appid、nonce、timestamp。
2.
拼成 key=value,用 & 连接。
3.
用该 appId 的 signKey 做 HMAC-SHA1。
4.
把摘要格式化成大写十六进制,写入 X-Sign。
待签字符串:
appid=<appId>&nonce=<nonce>&timestamp=<timestamp>
示例(signKey 为 test-secret):
appid=AppId_202506&nonce=5fa7d29c&timestamp=1719999123
X-Sign: ADF16F62ED8CC7071036D19ECAADC0E816EB3B4B
修改于 2026-09-23 05:08:43
上一页
数据字典
下一页
在线调试
Built with