取得觀看頁 SDK 授權令牌

更新時間：2024-04-22 19:18:32

介面說明

1、获取观众观看调用接口token
2、该token用于观看页SDK调用watch-api相关接口
3、接口支持https协议

介面URL

http://api.polyv.net/live/v3/channel/watch/get-watch-api-token

請求方式

POST

介面限制

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

請求參數說明

參數名	必選	類型	說明
appId	true	String	帳號 appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`生成簽名的 appSecret 金鑰作為通訊資料安全的關鍵資訊，嚴禁保存在用戶端直接使用，所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
channelId	true	String	頻道號
viewerId	true	String	觀眾 viewerId，長度：1-64位字元
nickname	false	String	暱稱
avatar	false	String	觀眾頭像
openid	false	String	微信的 openId
actor	false	String	用戶頭銜

範例

http://api.polyv.net/live/v3/channel/watch/get-watch-api-token

表單參數：

viewerId=test1234&appId=frlr1zazn3&sign=342122E84F0BD86BF217F1A46942D79D&userId=1b448be323&channelId=2094979&timestamp=1634264231586

回應參數說明

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

data欄位說明

參數名	類型	說明
token	String	呼叫介面 token，5小時有效

Java請求範例

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

/**
 * 获取观众观看调用接口token
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetWatchApiToken() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/watch/get-watch-api-token";
    String channelId = "2094979";
    String viewerId = "test1234";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("userId", userId);
    requestMap.put("viewerId", viewerId);
    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": {
        "token": "fri7txjyy1"
    }
}

異常範例

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