讲师单点登录
更新时间:2024-10-21 09:33:43
功能介绍
单点登录可以实现直接登录已有系统,免登录操作进入互动学堂后台,做直播相关设置。
适用场景
互动学堂单点登录到讲师上课页面
接口流程
设置登录token --> 在讲师登录地址加上登录token和老师Id --> 上课页面
1、设置token
接口描述
1、讲师单点登录设置token接口
2、(timestamp, appId)参与sign签名,并和sign一起通过url传递,请求体参数不参与签名,通过post请求体传递【请设置请求头contentType:application/json】
3、接口支持https协议
接口URL
http://api.polyv.net/hi-class-api/open/teach/v1/set-token
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为32位大写的MD5值【详见签名生成规则】 |
请求体参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| teacherId | true | String | 讲师Id(teacherId) |
| token | true | String | 单点登录token,一次性有效,过期时间一个小时 |
示例
http://api.polyv.net/hi-class-api/open/teach/v1/set-token?appId=frlr1zazn3&sign=6387F30E550150DD7A1AB11376137A6E×tamp=1634631207876
请求体参数
{
"teacherId": "g3fdl05syf",
"token": "269gH563903OSUwylnAT"
}
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| error | Error | 错误对象【详见全局错误说明】 |
| data | Object | 请求成功或失败时为空 【详见data字段描述】 |
data字段描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| status | Boolean | 成功:true,失败:false |
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
private static final Logger log = LoggerFactory.getLogger(VClassSSOTest.class);
/**
* 讲师单点登录
* @throws IOException
* @throws NoSuchAlgorithmException
*/
@Test
public void tokenLogin() throws IOException, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String appId = super.appId;
String appSecret = super.appSecret;
String timestamp = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/hi-class-api/open/teach/v1/set-token";
String teacherId = "g3fdl05syf";
String token = getRandomString(20);
//http 调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("appId", appId);
requestMap.put("timestamp", timestamp);
requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
Map<String, Object> jsonMap = new HashMap<>();
jsonMap.put("teacherId", teacherId);
jsonMap.put("token", token);
url = HttpUtil.appendUrl(url, requestMap);
String response = HttpUtil.postJsonBody(url, JSON.toJSONString(jsonMap), null);
log.info("测试讲师单点登录成功:{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"requestId": "5bc5c3a4a88a487192cb0256b1dadb7f.97.16346312121920507",
"data": null,
"success": true
}
异常示例
{
"code": 400,
"status": "error",
"data": "",
"error":{"code":xx,"desc":"错误描述"}
}
2、拼接地址登录
直接登录
通过上面API设置讲师登录token之后,拼接地址如下:
https://s.vclass.com/live-web-hi-class/teacher/tokenLogin?teacherId=xxxx&token=ssss&lessonId=101
URL参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| teacherId | true | String | 讲师Id(teacherId) |
| token | true | String | 单点登录token,一次性有效,过期时间一个小时 |
| lessonId | false | Integer | 非必传参数,如果传了这个参数可以跳转到对应的课节,不传,默认显示课节列表 |
响应说明
正常登录后直接进入讲师页面
异常登录页面会有相关提示
