設定直播子帳號單點登入 Token

更新時間：2022-09-02 18:08:07

介面描述

1、设置直播子账号单点登录的token
2、token参数请勿过于简单，建议使用16位随机字符串
3、token设置后需要10秒内及时使用
4、接口支持https协议

介面 URL

http://api.polyv.net/live/v3/user/set-sso-token

線上 API 呼叫

請求方式

POST

介面限制

1、介面同時支援 HTTP 與 HTTPS，建議使用 HTTPS 以確保介面安全，介面呼叫有頻率限制，詳細請參閱

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	目前 13 位毫秒級時間戳，3 分鐘內有效
sign	true	String	簽名，為 32 位大寫的 MD5 值，`產生簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有 API 都必須透過客戶自己伺服器中轉呼叫 POLYV 伺服器取得回應資料`【詳見簽名產生規則】
token	true	String	唯一的字串
childEmail	true	String	直播子帳號對應的電子郵件帳號

範例

http://api.polyv.net/live/v3/user/set-sso-token

表單參數：

appId=frlr1zazn3&sign=DE7CB3024B1C1D844031D77B774F4E38&timestamp=1621840259733&token=111&childEmail=xxx@polyv.net

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200 為成功回應，非 200 為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當 code 為 400 或 500 時，輔助描述錯誤原因
data	String	回應成功時回傳 success 字串，失敗時回傳空字串

Java 請求範例

快速接入基礎程式碼請下載相關依賴原始碼，點此下載原始碼，下載後加入自己的原始碼工程中即可。測試案例中的 HttpUtil.java 和 LiveSignUtil.java 都包含在下載檔案中。

強烈建議您使用直播 Java SDK 完成 API 的功能對接，直播 Java SDK 對 API 呼叫邏輯、例外處理、資料簽名、HTTP 請求執行緒池進行了統一封裝與最佳化。

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
 /**
     * 设置直播子账号单点登录token
     * @throws IOException
     * @throws NoSuchAlgorithmException
     */
    @Test
    public void testSetUserLoginToken() throws IOException, NoSuchAlgorithmException {
        //公共参数,填写自己的实际
        String appId = super.appId;
        String appSecret = super.appSecret;
        String userId = super.userId;
        String childEmail = super.childEmail;
        String timestamp = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "https://api.polyv.net/live/v3/user/set-sso-token";
        String token="111";

        //http 调用逻辑
        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("appId", appId);
        requestMap.put("childEmail", childEmail);
        requestMap.put("timestamp", timestamp);
        requestMap.put("token", token);
        requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.info("测试设置直播子账号单点登录token，返回值：{}", response);
        //do somethings

    }

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":"success"
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}