保利威文档中心

帮助中心

单点登录后台

更新时间:2024-10-21 09:33:43

描述

单点登录可以实现在登录已有系统的状态下,免登录操作进入保利威的账号,做相关设置

适用场景

保利威后台单点登录:账号。

账号:进入账号后台,获取最高的管理员权限,管理所有课程、课节,适合机构管理员的登录跳转

温馨提示

当前文档中涉及接口域名 https://hiclass.polyv.net 为保利威saas的默认域名,如客户做了cname定制,需修改为cname的对应域名进行调用;避免影响单点登录功能的使用。

如何操作

1.操作流程

2.调用接口说明
操作类型 设置token接口(点击可查看详细接口调用) 单点登录后台接口
账号 https://api.polyv.net/live/v3/user/set-sso-token https://hiclass.polyv.net/hi-class-admin/admin/open/user/v1/token-login
3.操作步骤
Step1.设置单点登录token参数
接口URL
1.根据操作类型(账号)选择对应的设置token接口URL
    账号:https://api.polyv.net/live/v3/user/set-sso-token
2.接口说明
    支持格式:JSON
    请求方式:POST
    请求数限制:TRUE
    token 参数请勿过于简单,建议使用16位随机字符串
    支持https协议
请求参数
参数名 必选 类型 说明
appId true String 从API设置中获取,在直播系统登记的appId
timestamp true String 当前13位毫秒级时间戳,3分钟内有效
token true String 唯一的字符串
sign true String 签名,为32位大写的MD5值
响应成功JSON示例
{
    "code": 200,
    "status": "success",
    "message": "",
    "data": "success"
}
响应失败JSON示例

未输入appId

{
    "code": 400,
    "status": "error",
    "message": "appId is required.",
    "data": ""
}
接口返回字段说明
参数名 说明
code 请求状态响应码
status 请求状态
message 错误信息
data 成功时候返回success字符串
Step2.成功设置token接口后,调用单点登录后台接口进行授权登录操作。
接口URL
1.根据操作类型(账号)选择对应的单点登录后台接口URL
    账号:https://hiclass.polyv.net/hi-class-admin/admin/open/user/v1/token-login
2.接口说明
    请求方式:GET
    请求数限制:TRUE
    用于获取token后授权登录互动学堂后台
    支持https协议
请求示例
https://hiclass.polyv.net/hi-class-admin/admin/open/user/v1/token-login?userId=userId123&token=token1234&redirect=%2Fadmin%2Fcourse
操作类型为账号的请求参数
参数名 必选 类型 说明
userId true String 账号id
token true String 通过账号token设置的token串,10秒内且一次验证有效
redirect false String 完成授权后重定向地址,使用url编码(默认:/admin/lesson;不需要填写域名部分。)
响应成功示例

验证成功则会重定向到相应的网页,否则返回错误

联系客服,在线咨询