修改分類設定
更新時間:2025-01-14 15:52:38
介面描述
1、通过分类id,修改一级分类的属性,例如是否源文件播放等
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
4、每个账户预设根目录,名字为默认分类
介面URL
http://api.polyv.net/v2/video/{userid}/updateCataProfile
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數描述
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| ptime | true | Long | 當前時間的毫秒級時間戳,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁保存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| cataid | true | String | 分類id,僅能設定一級分類的屬性,該參數取得自【取得分類及子分類】 |
| isSettings | false | String | 是否啟用設定,預設值為Y:開啟 Y為開啟 N為關閉 |
| keepSource | false | String | 原始檔案播放設定開關(僅對新上傳影片有效),預設值為0:非原始檔案播放 如果為原始檔案播放,encrypt、encryptLevel、isEdu、encodeAAC參數不生效 1:開啟 0:關閉 |
| encrypt | false | String | 影片加密設定開關(僅對新上傳影片有效),預設值為0:關閉 1:開啟 0:關閉 |
| hlslevel | false | String | 行動端加密設定(僅對新上傳影片有效),預設值為open:非加密授權 open:非加密授權; web:WEB授權; app:APP授權; wxa_app:小程式授權; |
| isEdu | false | String | 影片最佳化(僅對新上傳影片有效),預設值為0:關閉 1:開啟 0:關閉 |
| encode_aac | false | String | 產生音訊檔案(僅對新上傳影片有效),預設為0:關閉 該功能只對部分有權限用戶開放 1:開啟 0:關閉 |
| playerId | false | String | 播放器id,用於設定當前分類下的影片使用哪個播放器進行播放 |
範例
http://api.polyv.net/v2/video/1b448be323/updateCataProfile
表單參數:
isEdu=1&encode_aac=1&encrypt=1&isSettings=Y&keepSource=0&sign=726E92932FA8EB35E4BD6B01E3F740CF512FBD86&cataid=1617160372987&ptime=1617235796542&hlslevel=app
回應參數描述
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 成功返回true,錯誤返回空字串 |
Java請求範例
快速接入基礎代碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log = LoggerFactory.getLogger(VodVideoCategoryTest.class);
/**
* 修改分类设置
*/
@Test
public void testUpdateVideoCategoryProfile() 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 + "/updateCataProfile";
String cataId = "1617160372987";
String isSettings = "Y";
String keepSource = "0";
String encrypt = "1";
String hlsLevel = "app";
String isEdu = "1";
String encodeAac = "1";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("ptime", ptime);
requestMap.put("cataid", cataId);
requestMap.put("isSettings", isSettings);
requestMap.put("keepSource", keepSource);
requestMap.put("encrypt", encrypt);
requestMap.put("hlslevel", hlsLevel);
requestMap.put("isEdu", isEdu);
requestMap.put("encode_aac", encodeAac);
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": true
}
異常範例
{
"code": 400,
"status": "error",
"message": "sign can not be empty.",
"data": ""
}
