保利威文档中心

幫助中心

建立分類

更新時間:2025-01-14 15:50:35

介面說明

1、创建视频分类
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
4、每个账户预设根目录,名字为默认分类

介面URL

http://api.polyv.net/v2/video/{userid}/addCata

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名 必選 類型 說明
ptime true Long 目前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】
cataname true String 分類名稱,不超過40個字元
parentid true String 新建的分類目錄的上層目錄,值為1時表示根目錄,該參數取得自【取得分類及子分類】
format false String 回傳的資料格式,預設回傳json格式
xml:回傳xml格式
json:回傳json格式

範例

http://api.polyv.net/v2/video/1b448be323/addCata

表單參數:

sign=672925B1717AD3AB8F39DB0BFBE18B1D82F29B41&cataname=分类名称1&ptime=1617160371881&parentid=1

回應參數說明

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

data欄位說明

欄位 類型 說明
cataid Long 新建的分類目錄id
catatree String 新建的分類目錄樹,逗號分隔(狀態為半形),例如 1b8be3,239c2e

Java請求範例

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

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


private static final Logger log = LoggerFactory.getLogger(VodVideoCategoryTest.class);
/**
 * 创建分类
 */
@Test
public void testAddVideoCategory() throws Exception, NoSuchAlgorithmException {
        //公共参数,填写自己的实际参数
        String secretKey = super.secretKey;
        String userId = super.userId;
        String ptime = String.valueOf(System.currentTimeMillis());
        //业务参数
        String url = "http://api.polyv.net/v2/video/" + userId + "/addCata";
        String cataName = "分类名称1";
        String parentId = "1";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("ptime", ptime);
        requestMap.put("cataname", cataName);
        requestMap.put("parentid", parentId);
        requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
        String response = HttpUtil.postFormBody(url, requestMap);
        log.debug("测试创建分类,{}", response);
        //do somethings
}

回應範例

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

成功範例

{
  "code": 200,
  "status": "success",
  "message": "success",
  "data": {
    "catatree": "1,1617160372987",
    "cataid": 1617160372987
  }
}

異常範例

{
  "code": 400,
  "status": "error",
  "message": "没有填写栏目名称",
  "data": ""
}
联系客服,在线咨询
在线咨询