頻道單一登入

更新時間：2022-03-17 10:03:42

描述

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

適用場景

Polyv 後台單一登入：頻道

頻道：進入頻道後台，僅取得當前頻道的管理員權限，可管理當前頻道，適合頻道管理員登入跳轉。

溫馨提示

當前文件中涉及的接口域名 https://live.polyv.net （舊版直播後台）或 https://console.polyv.net （新版直播後台）為 Polyv SaaS 的預設域名，若客戶做了 CNAME 客製化，需修改為 CNAME 的對應域名進行呼叫；避免影響單一登入功能的使用。

如何操作

1.操作流程

2.呼叫接口說明

操作類型	設定 Token 接口（點擊可查看詳細接口呼叫）	單一登入後台接口
頻道	https://api.polyv.net/live/v2/channels/{channelId}/set-token	http://live.polyv.net/#/teacher/{频道号}

3.操作步驟

Step1.設定單一登入 Token 參數

接口 URL

1.根据操作类型（频道）选择对应的设置token接口URL
    频道：https://api.polyv.net/live/v2/channels/{channelId}/set-token
2.接口说明
    支持格式：JSON
    请求方式：POST
    请求数限制：TRUE
    接口URL中的{channelId}为频道号
    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://live.polyv.net/teacher/auth-login
2.接口说明
    支持格式：JSON
    请求方式：GET
    请求数限制：TRUE
    用于获取token后授权登录直播后台
    支持https协议

操作類型為頻道請求參數

參數名	必選	類型	說明
channelId	true	String	頻道號
token	true	String	透過頻道 Token設定的 Token 字串，10 秒內且一次驗證有效
redirect	true	String	完成授權後重新導向地址，使用 URL 編碼，如頻道後台：http://live.polyv.net/#/teacher/{频道号} 注意：若做了 CNAME 需將 live.polyv.net 換成 CNAME 域名

響應成功範例

驗證成功則會重新導向到相應的網頁，驗證失敗則會重新導向到頻道登入頁