# 查询账号的加密设置

### 接口描述

```
1、查询用户账号下的加密设置
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
```

### 接口URL

```
http://api.polyv.net/v2/setting/{userid}/get-playsafe
```

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

### 请求方式

```
GET
```

### 接口约束

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)】 |

### 示例

```requestUrl
http://api.polyv.net/v2/setting/1b448be323/get-playsafe?sign=3F36EB09AEF45684A42B1870F33D5C1B11009559&userid=1b448be323&ptime=1617699566988
```

### 响应参数描述

| 参数名     | 类型      | 说明                                                                                                                                                                                             |
| ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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  | 响应成功时返回账号加密信息【详见[data字段说明](https://git.polyv.net/help-center/document-center/-/blob/master/vod/api/playsafe/encryption/get_encryption_setting.md?id=data%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E)】 |

#### data字段说明

| 参数名      | 类型     | 说明                                                                        |
| -------- | ------ | ------------------------------------------------------------------------- |
| encrypt  | String | <p>是否开启加密<br>1：开启<br>0：关闭</p>                                             |
| hlslevel | String | <p>视频加密设置<br>open: 非加密授权<br>web: WEB授权<br>app: APP授权<br>wxa_app：小程序授权</p> |

**返回错误代码列表**

| 错误代码 | message                        | 说明                   |
| ---- | ------------------------------ | -------------------- |
| 400  | sign can not be empty.         | 加密串为空                |
| 400  | ptime is too old.              | 时间戳过期                |
| 400  | ptime is illegal.              | 时间戳参数格式不对或者超过当前时间3分钟 |
| 400  | Could not find user by userid. | userid不存在            |
| 400  | the sign is not right.         | 加密串不正确               |

### 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(VodVideoEncryptionTest.class);

 /**
  * 获取账号加密设置
  */
 @Test
 public void testGetPlaysafe() throws Exception, NoSuchAlgorithmException {
     //公共参数,填写自己的实际参数
     String secretKey = super.secretKey;
     String userId = super.userId;
     String ptime = String.valueOf(System.currentTimeMillis());
     //业务参数
     String url = String.format("http://api.polyv.net/v2/setting/%s/get-playsafe", userId);

     Map<String, String> requestMap = new HashMap<>();
     requestMap.put("userid", userId);
     requestMap.put("ptime", ptime);
     requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

     String response = HttpUtil.get(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": {
		"encrypt": "1",
		"hlslevel": "open"
	}
}
```

异常示例

```json
 {
	"code": 400,
	"status": "error",
	"message": "ptime is too old.",
	"data": ""
}
```
