API Authentication

1. Overview

Base URL:

Supported format: JSON

Character encoding: UTF-8

Protocols: Both HTTP and HTTPS are supported. HTTPS is recommended for secure data transfer.

Method: Token authentication

All API requests must include a valid token in the request header. The system validates the token; invalid tokens return an authentication error.

Include the following header on every API request:

Token: your_access_token_here

# curl example
curl -X GET "http://user.ipweb.cc/prod-api/open/customer/list?pageNum=1&pageSize=10&userName=" -H "token: your-access-token"

Header name: Token
Value: Access token string issued by the system
Length: Typically a 32–64 character alphanumeric string
Expiry: Tokens expire; obtain a new one when expired
Security: Keep your token confidential and do not share it with third parties

All APIs return a unified JSON response:

Field	Type	Description
code	Integer	Status code; `200` indicates success
msg	String	Response message
data	Object	Response payload; structure varies by endpoint

Possible error codes for dynamic traffic APIs:

Code	Description	Resolution
200	Invalid authentication token	Verify the token is correct and not expired
200	Incomplete account info	Contact an administrator to check the account
500	Internal server error	Contact technical support

Error response example:

{
  "code": 200,
  "msg": "无效的认证令牌",
  "data": null
}