伯索开放平台
首页
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 · iOS 接入

本文说明如何将伯索云学堂模块化 SDK 接入自有 iOS App,并对照对外 Demo:YXTSDK-iOS-Demo(以仓库内《接入说明.md》与 Podfile 为准)。
开放平台:https://open.plaso.cn/ · 用户访问 Token:https://open.plaso.cn/api-120430699 · 调用流程与签名:《[Open API/调用流程](../../Open API/接入须知/调用流程.md)》 · SDK 对接流程:《云学堂模块化SDK/00-概述》

1. 申请开放平台凭证#

1.
联系伯索商务开通开放平台账号。
2.
获取唯一标识 appId 与签名密钥 signKey(即课堂 SDK Demo 中的 appKey,同一把密钥)。
3.
准备测试用户 loginName(学生 / 教师 / 助教)。

2. 集成 Pod#

要求值
最低系统版本iOS 13.0
工具Xcode 14+(建议 15+),CocoaPods 1.12+
Specscdn.cocoapods.org + plaso-open-specs
主依赖PlasoFeaturedSDK 0.5.1(以 Demo Podfile / README 为准)
在 Podfile 中增加 Specs 源与依赖:
执行:
建议在 post_install 中统一 IPHONEOS_DEPLOYMENT_TARGET,并对 AliPlayer / RtsSDK 等传递依赖做 bitcode strip(Demo Podfile 已示例)。
当前 SDK 的模拟器 slice 为 x86_64。Apple Silicon 上请在 Podfile / 工程中设置:

使用对外 Demo 验证#

在授权页填写 appId、signKey、loginName 与用户类型后联调。Demo 客户端签名仅限测试。

3. 权限与 Info.plist#

课堂音视频能力需要声明:
NSCameraUsageDescription
NSMicrophoneUsageDescription
NSPhotoLibraryUsageDescription / NSPhotoLibraryAddUsageDescription
NSBluetoothAlwaysUsageDescription / NSBluetoothPeripheralUsageDescription
NSLocalNetworkUsageDescription
按需:定位相关描述
同时建议:
NSAppTransportSecurity 允许 SDK 所需资源访问(Demo 使用 NSAllowsArbitraryLoads,正式环境宜收紧)
将 yxt.html 加入 App Bundle(SDK WebView 兜底页,Demo 启动时复制到 tmp)
播放器 U3PlayerMainViewController 在 iPad 上只支持横屏。AppDelegate 的 supportedInterfaceOrientationsFor 宜直接返回 .all,同时在 Info.plist 中声明全部方向,否则 present 播放器会因方向没有交集而崩溃。

4. OpenAPI 获取 Token#

由业务服务端调用:
POST https://{host}/dataentry/user/getToken
正式环境示例 Host 为 https://www.plaso.cn。Body 示例:
{
  "appId": "your_app_id",
  "loginName": "student_login",
  "userType": "student",
  "validBegin": 1710000000,
  "validTime": 1200,
  "signature": "HEX_HMAC_SHA1"
}
签名步骤:
1.
业务参数加入 appId、validBegin、validTime(及 loginName、userType 等参与字段)。
2.
按参数名升序拼接为 k=v&k=v。
3.
使用 signKey 做 HMAC-SHA1,结果转大写十六进制得到 signature。
4.
将 signature 一并提交。
成功响应(code == 0)中 obj.token 为访问令牌,obj.expire 为有效秒数。
安全提示: Demo 在客户端签名仅为联调方便。生产环境请在自有服务端签名,避免 signKey 泄露。
无需用户密码。userType 不传时服务端默认按学生处理。

5. SDK 初始化与登录#

对应 Demo:PlasoSDKBootstrap.swift。switch(toOemPlatform: "plaso") 之后,业务域名为 https://www.plaso.cn。
拿到 Token 后(Demo 经 PlasoSDKBridge 包装,回调参数可为空):
实际业务请求示例:
POST {serviceHost}/yxt/servlet/user/getUserInfo
POST {serviceHost}/yxt/servlet/org/getOrgConfig

6. 嵌入业务页面#

前置条件:已完成 PlasoSDK.initSDK,且 Token 登录成功。建议每个 Tab 包一层 UINavigationController,SDK 页面作为该导航控制器的根控制器。

实时课堂#

设备SDK 类所在模块
iPhoneYXTLiveClassiPhoneVC(liveClass = true)PlasoLiveMini
iPadYXTRealTimeMainVCPlasoLiveMini
iPhone 的 YXTLiveClassiPhoneVC 会自己设置 navigationItem(右侧「新建课堂 / 课表」,标题处切换课堂与历史课堂)。iPad 的 YXTRealTimeMainVC 使用自绘导航栏,并在 viewWillAppear 里隐藏系统导航栏。若再套一层容器并把分段控件写到外层 navigationItem,系统导航栏显示的是外层 item,SDK 的新建课堂、课表不会出现。

作业巩固#

YXTNewHomeworkVC(PlasoFeatureWeb)。作为导航根页面嵌入,调用 startLoadWeb 时不传返回参数,Tab 根页面不显示返回。

资料中心#

平板提供入口,手机不展示。

我的#

SDK 没有统一的「我的」页面。可自建页面展示用户信息,并在 Token 失效时回到授权流程。

7. 联调检查清单#

pod install 成功,真机可运行(或 Rosetta 模拟器)。
服务端签发 Token,客户端登录成功。
iPhone / iPad 课堂页导航与新建课堂入口正常。
作业 Tab 可打开;Token 过期可回到授权页。
正式包未内置 signKey。

8. 常见问题#

Q: SignKey 能否写死在 App?
Demo 可以;正式发布请放到服务端。
Q: 是否需要密码登录?
OpenAPI getToken 不需要密码。

9. 联系方式#

对接过程中如遇文档或 SDK 问题,请通过商务 / 对接群反馈,并附带 SDK 版本、系统版本、操作步骤与日志。
修改于 2026-11-17 07:47:57
上一页
云学堂模块化 SDK · Android 接入
下一页
云学堂模块化 SDK · Harmony 接入
Built with