Query Account Encryption Settings

Updated: 2025-01-14 16:06:56

API Description

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

API URL

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

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. API calls have frequency limits. See details

Request Parameter Description

Parameter	Required	Type	Description
ptime	true	Long	Current time in milliseconds timestamp, valid within 3 minutes
sign	true	String	Signature, a 40-character uppercase SHA1 value. `The secretkey used to generate the signature is critical for communication data security. It must never be saved or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server and obtain response data.` See signature generation rules

Example

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

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure. See global error description
status	String	Response status text
message	String	Response description. When code is 400 or 500, it provides additional error details
data	Object	Returns account encryption information on success. See data field description

data Field Description

Parameter	Type	Description
encrypt	String	Whether encryption is enabled 1: Enabled 0: Disabled
hlslevel	String	Video encryption settings open: Non-encrypted authorization web: WEB authorization app: APP authorization wxa_app: Mini Program authorization

Error Code List

Error Code	message	Description
400	sign can not be empty.	Signature is empty
400	ptime is too old.	Timestamp has expired
400	ptime is illegal.	Timestamp parameter format is incorrect or exceeds current time by 3 minutes
400	Could not find user by userid.	User ID does not exist
400	the sign is not right.	Signature is incorrect

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click to download source code. After downloading, add it to your own source project. The test cases include HttpUtil.java and VodSignUtil.java in the downloaded file.

It is strongly recommended to use the VOD Java SDK for API integration. The VOD Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

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("ptime", ptime);
     requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));

     String response = HttpUtil.get(url, requestMap);
     log.debug("测试获取账号加密设置，{}", response);
     //do somethings
 }

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "encrypt": "1",
        "hlslevel": "open"
    }
}

Error Example

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

VOD Server API