單一登入後台

更新時間：2024-10-21 09:33:43

描述

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

適用場景

Polyv 後台單一登入：帳號。

帳號：進入帳號後台，取得最高的管理員權限，管理所有課程、課節，適合機構管理員的登入跳轉

溫馨提示

目前文件中涉及的接口域名 https://hiclass.polyv.net 為 Polyv 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；不需要填寫域名部分。）

響應成功範例

驗證成功則會重新導向到相應的網頁，否則回傳錯誤