伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. 接入须知
  • Open API 主要功能
  • Open API集成常用场景
  • 数据字典
  • 接入须知
    • 调用流程
    • 在线调试
    • 通用错误码
  • 用户信息管理
    • 添加用户
      POST
    • 修改密码
      POST
    • 删除用户
      POST
    • 更新用户
      POST
    • 用户精确查询
      POST
    • 查询多个用户
      POST
    • 用户访问Token
      POST
    • 验证用户Token有效期
      POST
  • 教材包管理
    • 查询机构教材包
      POST
    • 查询教材包内教材
      POST
    • 向学生分发教材包
      POST
  • 实时课堂管理
    • 创建实时课堂
      POST
    • 创建实时课堂(班)
      POST
    • 更新实时课堂
      POST
    • 更新实时课堂(班)
      POST
    • 删除实时课堂
      POST
    • 查询实时课堂列表
      POST
    • 更新实时课堂下听众用户
      POST
    • 获取实时课堂监控地址
      POST
    • 控制单个学员是否可以回看单次课
      POST
    • 获取单个课堂的回看地址
      POST
    • 删除单个历史课堂
      POST
    • 获取课堂考勤数据
      POST
    • 获取历史课堂信息
      POST
    • 获取历史课堂观看数据
      POST
    • 获取课堂互动信息
      POST
    • 获取课堂列表(新)
      POST
    • 获取实时课堂旁听链接
      POST
  • 班级管理
    • 创建班级
    • 更新班级
    • 删除班级
    • 查询班级列表
    • 向班级中添加学生
    • 从班级中移除学生
    • 更换学生所在班级
    • 老师列表中查询机构分校学科
    • 根据班级获取获取班级详情和人员信息
  • 学情数据
    • 获取学生课堂明细数据
    • 获取学生巩固明细数据
    • 获取学生测验明细数据
    • 获取学生辅导明细数据
    • 获取学生积分明细数据
  • 商城管理
    • 获取商品详情
    • 获取商品列表
    • 获取分校自定义商品栏目列表
    • 订单查询
    • 订单详情查询
  • 作业管理
    • 查询学生作业列表
    • 查询老师作业列表
  • 测验管理
    • 查询机构测评列表
    • 获取测评统计
    • 查询机构测验列表
    • 获取测验明细
  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": {}
}
修改于 2023-11-22 05:42:24
上一页
数据字典
下一页
在线调试
Built with