API Usage Guide

This guide explains how to use our API services, including authentication, error handling, latency diagnostics, rate limiting, and support resources.

🔐 Authentication

When calling our API, you must include your access token as a URL parameter in every request:

http://<ip:port>/your-endpoint?token=your_access_token

To obtain an access token, please sign up

All API responses will return an HTTP status code of 200 OK, regardless of whether the business result is successful.

The actual result should be determined by the code field in the response body.

{
  "code": 0,
  "message": "",
  "data": { ... }
}

If the HTTP status code is not 200, it indicates a system-level error (e.g., timeout, platform issues).

code	Meaning	Charged
0	Success	Yes
100	Invalid or expired token	No
301	Data fetch failed, please retry	No
302	Rate limit exceeded	No
303	Daily quota exceeded	No
400	Invalid parameters	No
500	Internal server error	No
600	Insufficient permissions	No
601	Insufficient balance	No

201 means resource not found but request succeeded, so it is still charged.

Set timeout to at least 60 seconds to avoid false failures.

Use /ping endpoint to test connectivity.

Region	Environment
Mainland China	prod-cn
Outside Mainland China	prod-global

No global limit, but some endpoints may have limits.