保利威文档中心

幫助中心

建立直播分類

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

介面描述

1、创建直播分类
2、接口支持https协议

介面URL

http://api.polyv.net/live/v3/user/category/create

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

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

範例

http://api.polyv.net/live/v3/user/category/create

表單參數:

appId=frlr1zazn3&sign=8D7D02BC9081B6DF5E9D4A651A7BDE35&categoryName=%E5%88%86%E7%B1%BB23411&timestamp=1621841318228

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回分類資訊【詳見data欄位說明
Data參數說明
參數名 類型 說明
categoryId String 分類id
categoryName String 頻道分類名稱
userId String POLYV使用者ID,與保利威官網一致,取得路徑:官網->登入->直播(開發設定)
rank Integer 分類排序號,rank=0表示為預設排序

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(AccountTest.class);
/**
 * 创建直播分类
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testCreateCategory() 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/user/category/create";
    String categoryName="分类23411";
    
    //http 调用逻辑
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("categoryName", categoryName);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试创建直播分类,返回值:{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "categoryId":360879,
        "categoryName":"分类23411",
        "userId":"1b448be323",
        "rank":4
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}
联系客服,在线咨询