伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. 云学堂模块化SDK
  • 产品介绍
    • 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

云学堂模块化 SDK · Android 接入

本文说明如何将伯索云学堂模块化 SDK 接入自有 Android App。公开能力包括实时课堂、作业巩固、资料中心。细节对照对外 Demo:YXTSDK-Android-Demo。
开放平台:https://open.plaso.cn/ · 用户访问 Token:https://open.plaso.cn/api-120430699

1. 快速接入#

要求值
最低系统版本minSdk >= 26(Android 8.0)
建议编译compileSdk 34,targetSdk 33,JDK 17
依赖cn.plaso:yxtsdk:2.0.21
Mavenhttps://nexus.plaso.cn/repository/maven-public/
入口类YxtSDK

1.1 依赖#

课堂、巩固、资料中心均在同一依赖内。

1.2 权限#

模块化 SDK 进实时课堂同样依赖麦克风、摄像头、蓝牙与通知。宿主须在 AndroidManifest.xml 声明下列权限,并在进课前完成危险权限的运行时申请(与《实时课堂/Android》权限要求一致):
<!-- 网络 -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

<!-- 麦克风 / 摄像头(危险权限,须运行时申请) -->
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

<!-- 蓝牙(耳机 / 音频路由;Android 12+ 的 CONNECT 须运行时申请) -->
<uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

<!-- 通知(Android 13+ 须运行时申请) -->
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />

<!-- 前台服务;Android 14+ 麦克风类型前台服务须声明 MICROPHONE -->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
权限用途说明
RECORD_AUDIO上课发言 / 录制危险权限,进课前申请
CAMERA视频上课危险权限,进课前申请
BLUETOOTH / BLUETOOTH_CONNECT蓝牙耳机等音频设备CONNECT 自 Android 12 起为运行时权限
POST_NOTIFICATIONS课堂相关通知自 Android 13 起为运行时权限
FOREGROUND_SERVICE / FOREGROUND_SERVICE_MICROPHONE麦克风前台服务Android 14+ 使用麦克风类型前台服务时必声明

1.3 使用对外 Demo 验证#

1.
克隆 YXTSDK-Android-Demo。
2.
Android Studio 打开工程,确认 cn.plaso:yxtsdk:2.0.21。
3.
在授权页填写伯索分配的 appId、signKey(即课堂 SDK Demo 中的 appKey,同一把密钥)、loginName 与用户类型后登录联调。
Demo 在客户端签名仅限联调;生产环境必须由业务服务端保存密钥并签发 Token。

2. 申请凭证与用户#

1.
联系商务 / 4000258208 / business@plaso.cn 开通开放平台账号,获取 appId、signKey(与 StyleUpime 文档中的 appKey 为同一密钥)。
2.
在机构后台准备用户;loginName 填登录用户名,不需要密码。
3.
userType 必须与角色一致:student / teacher / assistant;不传时服务端按学生处理。

3. 初始化#

SDK 初始化不需要 Token。机构名传 plaso(以商务分配为准)。
也可不传回调:YxtSDK.init(context, "plaso")。
正式环境业务域名为 www.plaso.cn。init 返回后设置 PlasoProp.setRealoem_server(host) 与 setOem_server("https://{host}/")(host 取 www.plaso.cn)。EnvManager.setEnv 放在 init 之后。OpenAPI、环境管理与 PlasoProp 必须指向同一主机。

4. 获取 Token#

由业务服务端调用:
POST https://{host}/dataentry/user/getToken
{
  "appId": "your_app_id",
  "loginName": "student_login",
  "userType": "student",
  "validBegin": 1710000000,
  "validTime": 1200,
  "signature": "HEX_HMAC_SHA1"
}
签名:
1.
参与字段:appId、loginName、userType、validBegin(Unix 秒)、validTime(建议 1200)。密码不参与。
2.
按 key 排序拼成 k=v&k=v。
3.
用 signKey 做 HmacSHA1,结果转大写十六进制(前导 0 不补)。
成功时 code == 0,obj.token 为访问令牌,obj.expire 为有效秒数。接口按 loginName + userType 查用户,找不到时 code == 1(no such user)。

5. 写入 Token#

userType 与换 Token 时相同,大小写敏感。onInitSuccess 之后再打开业务页。

6. 打开业务页面#

前置:已 init,且 updateToken 成功。

6.1 实时课堂#

backButton 为 true 时显示返回。平板进入课堂首页,手机按角色进入老师或学生课堂页。

6.2 作业巩固#

平板学生进入学生作业页,其余进入作业页。

6.3 资料中心#

平板显示入口后打开:
手机不显示资料中心入口。可用 YxtSDK.isPad() 区分形态(平板横屏、手机竖屏)。

6.4 我的#

SDK 无统一「我的」公开页;可自建页面展示登录名、用户类型、AppId、Token 过期时间。

7. 登出#

onTokenError 中同样调用 doLogout(),清理本地 Token 与页面后回到授权流程。

8. 联调检查清单#

依赖可下载,Debug 包可真机运行。
已声明并按系统版本申请 RECORD_AUDIO、CAMERA、蓝牙、POST_NOTIFICATIONS;Android 14+ 已声明 FOREGROUND_SERVICE_MICROPHONE。
init 成功,环境域名与 OpenAPI Host 一致。
服务端 getToken 验签通过,客户端完成 updateToken。
实时课堂、巩固、资料中心(平板)可打开。
Token 失效触发 onTokenError 并能登出返回。
正式包未内置 signKey。
修改于 2026-11-17 07:47:57
上一页
云学堂模块化 SDK 概述
下一页
云学堂模块化 SDK · iOS 接入
Built with