設定影片播放密碼

更新時間：2025-01-14 16:10:00

介面描述

1、通过视频id修改视频播放密码
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/video-setting-save

線上API呼叫

請求方式

POST

介面限制

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

請求參數說明

參數名	必填	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
vids	true	String	影片id，多個使用英文逗號分隔
describ	false	String	影片描述
password	false	String	影片密碼
publishUrl	false	String	首發外鏈
tag	false	String	影片標籤
title	false	String	影片標題

範例

http://api.polyv.net/v2/video/1b448be323/video-setting-save

表單參數：

describ=%E6%8F%8F%E8%BF%B0&password=123456&vids=1b448be323631e6e80e12e0790609f68_1%2C1b448be323d7e4c49d5634abd5af0bcb_1&sign=0A8F7BCF427C94402CBDCBAC23118250B0879782&tag=%E6%A0%87%E7%AD%BE&title=%E8%A7%86%E9%A2%91%E6%A0%87%E9%A2%98&ptime=1618218158363

回應參數說明

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Object	回應成功時回傳修改影片個數，失敗時回傳空字串

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(PasswordTest.class);
/**
 * 设置视频播放密码
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testSetVideoPassword() 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+"/video-setting-save";
    String vids = "1b448be323631e6e80e12e0790609f68_1,1b448be323d7e4c49d5634abd5af0bcb_1";
    String tag = "标签";
    String title = "视频标题";
    String password = "123456";
    String describ = "描述";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);
    requestMap.put("tag", tag);
    requestMap.put("title", title);
    requestMap.put("password", password);
    requestMap.put("describ", describ);
    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":2
}

異常範例

{
    "code":400,
    "status":"error",
    "message":"the sign is not right.",
    "data":""
}