# 设置视频播放密码

### 接口描述

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

### 接口URL

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

[在线API调用](https://git.polyv.net/help-center/document-center/-/blob/master/req.html?api=http:/api.polyv.net/v2/video/%7Buserid%7D/video-setting-save/README.md)

### 请求方式

```
POST
```

### 接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，[详细请查看](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/limit/README.md)

### 请求参数描述

| 参数名        | 必选    | 类型     | 说明                                                                                                                                                                                                        |
| ---------- | ----- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| userid     | true  | String | 保利威点播账户id，可以参考【[获取密匙](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/getSecretKey/README.md)】获取，获取路径：官网->登录->点播（API接口）                                                           |
| ptime      | true  | Long   | 当前时间的毫秒级时间戳，3分钟内有效                                                                                                                                                                                        |
| sign       | true  | String | 签名，为40位大写的SHA1值,`生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据`【详见[签名生成规则](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/buildSign/README.md)】 |
| vids       | true  | String | 视频id，多个使用英文逗号分隔                                                                                                                                                                                           |
| describ    | false | String | 视频描述                                                                                                                                                                                                      |
| password   | false | String | 视频密码                                                                                                                                                                                                      |
| publishUrl | false | String | 首发外链                                                                                                                                                                                                      |
| tag        | false | String | 视频标签                                                                                                                                                                                                      |
| title      | false | String | 视频标题                                                                                                                                                                                                      |

### 示例

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

表单参数：

```requestUrl
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&userId=1b448be323&ptime=1618218158363
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                              |
| ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
| code    | Integer | 响应状态码，200为成功返回，非200为失败【详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)】 |
| status  | String  | 响应状态文本信息                                                                                                                        |
| message | String  | 响应描述信息，当code为400或者500的时候，辅助描述错误原因                                                                                               |
| data    | Object  | 响应成功时返回修改视频个数，失败时返回空字符串                                                                                                         |

### Java请求示例

快速接入基础代码请下载相关依赖源码， [点击下载源代码](https://git.polyv.net/help-center/document-center/-/blob/master/third_res/util.zip) ,下载后加入到自己的源码工程中即可。测试用例中的**HttpUtil.java 和 VodSignUtil.java** 都包含在下载文件中。

> 强烈建议您使用[点播Java SDK](https://git.polyv.net/help-center/document-center/-/blob/master/vod/java/README.md)完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

```java
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("userId", userId);
    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

}
```

### 响应示例

系统全局错误说明详见[全局错误说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/errorInfo/README.md)

成功示例

```json
{
    "code":200,
    "status":"success",
    "message":"success",
    "data":2
}
```

异常示例

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