Polyv Help Center

Help Center

Create Isolation Zone

Updated: 2022-09-02 18:08:07

API Description

1、创建隔离区
2、接口支持https协议

API URL


Request Method

POST

API Constraints

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

  2. For group account APIs, use the appId and appSecret of the primary group account when calculating the signature.

  3. Creating an isolation zone with the same userId will throw an exception.

Request Parameter Description

Parameter Required Type Description
appId true String Primary group account appId
timestamp true Long Current 13-digit millisecond timestamp, valid for 3 minutes
userId true String Global user ID, i.e., userId
sign true String Signature, a 32-character uppercase MD5 value. The appSecret used to generate the signature is critical for communication data security. It must not be stored 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 for response data. See signature generation rules

Example


Response Parameter Description

Parameter Type Description
code Integer Status code, same as HTTP status code, used to determine the basic response status
status String Response result, determined by the business. Returns success on success, error on failure
success Boolean Whether the response was successful
requestId String Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error Object Error information when the status code is not 200 See Error field description
data Object See data field description

Error Parameter Description

Parameter Type Description
code Integer Error code, used to determine the specific error reason
desc String Error description, corresponding to error.code

Data Parameter Description

Parameter Type Description
isolationId String Isolation zone ID

Java Request Example


Response Example

For global system error descriptions, see Global Error Description

Success Example


Error Example

{
    "code": 400,
    "status": "error",
    "error": {
        "code": 10003,
        "desc": "时间戳过期"
    },
    "success": false
}
联系客服,在线咨询