取得頻道API的存取權杖

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

介面說明

1、接口用于获取频道级别的API访问令牌（channel access token），以下简称token
2、token可以用于访问指定一个频道号的API，并且访问路径需符合以下模式：/live/v3/channel/**，未来会逐步扩展其功能
3、token可以用于接入直播平台一些特定的SDK
4、接口支持https协议

介面URL

https://api.polyv.net/live/v3/common/token/get-channel-token

線上API呼叫

請求方式

POST

介面限制

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

2、單一頻道在1個小時之內呼叫介面的次數不得超過500次，限制機制在未來可能會有所調整，建議開發者在服務端統一快取token，不要頻繁呼叫介面

3、token存在有效期限，開發者需要自行維護更新，可以根據介面回傳的失效時間主動重新整理token，亦或者在token失效後重新取得，注意不要多處重複呼叫介面

4、至少留出512位元組給channelToken

請求參數說明

參數名	必填	類型	說明
appId	true	String	帳號appId【詳見取得金鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`產生簽名的appSecret金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
channelId	true	String	頻道號
disposable	false	Boolean	是否一次性有效，true/false，預設為false
expireSeconds	false	Integer	token有效時長，單位為秒，取值範圍：0 < expireSeconds <= 3600，預設為1800秒

範例

Request URL: https://api.polyv.net/live/v3/common/token/get-channel-token
Request Method: POST
Content-Type: application/x-www-form-urlencoded
Form Data: appId=<yourAppId>&timestamp=1623308604852&sign=099846EF3DD92402DF9C60804556CE37&channelId=1762528

回應參數說明

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

Data參數說明

參數名	類型	說明
expireTime	Long	失效時間，13位毫秒級時間戳，在該時間之前的token有效，否則所呼叫介面將回傳code=15，代表無效token，需要重新取得
channelToken	String	頻道介面存取權杖，為了避免權限過大而導致誤操作，該token僅限存取該頻道資料，否則所呼叫介面將回傳無效token的錯誤

使用token呼叫頻道介面時，傳了無效token的回傳結果範例

{
    "code": 15,
    "status": "error",
    "message": "invalid token.",
    "data": null
}

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(getClass());
/**
 * 获取频道API的访问令牌
 * @throws Exception
 */
@Test
public void testGetChannelApiToken() throws Exception {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "https://api.polyv.net/live/v3/common/token/get-channel-token";
    String channelId = "1762528";

    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("获取频道API的访问令牌，返回值：{}",response);
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "channelToken": "65027cb0765c4d07afad13ba60467af2",
        "expireTime": 1623238164635
    }
}

異常範例

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

api 呼叫頻率限制

{
    "code": 400,
    "status": "error",
    "message": "qps exceeds number of calls, limit: %s",
    "data": ""
}

expireSeconds值受限制，必須 0 < expireSeconds <= 3600

{
    "code": 400,
    "status": "error",
    "message": "expireSeconds limited.",
    "data": ""
}