API Usage Guide

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

🔐 Authentication

To access 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 request a token, please register.

🚨 Response Handling & Error Codes

All API responses return HTTP status code 200 OK, regardless of business outcome.

You must rely on the code field in the JSON response body to determine the business-level result.

Example Response

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

⚠️ If the HTTP status code is not 200, it indicates a system-level error (e.g., timeout, platform exception). Please contact us for further investigation.

Business Code Reference

`code`	Meaning	Billed
`0`	Success	Yes 💰
`100`	Invalid or Inactive Token	No
`201`	No Content Available	Yes 💰
`301`	Collection Failed. Please Retry.	No
`302`	Rate Limit Exceeded	No
`303`	Daily Quota Exceeded	No
`400`	Invalid Parameters	No
`500`	Internal Server Error	No
`600`	Permission Denied	No
`601`	Insufficient Balance	No

·201 indicates that the requested resource does not exist (e.g., product or article not found). The request is still billed because it was successfully processed — the data simply doesn’t exist.

⏱ Timeout Recommendation

Although most API requests respond within a few seconds, we recommend setting your request timeout to at least 60 seconds.

This does not indicate that our API is slow — it simply helps avoid unintended errors or duplicate charges due to temporary network issues or client-side timeouts.

🐢 Latency Diagnostics

If you experience unusually slow response times, you can test your network connection to our server using the /ping endpoint

Normal responses typically return within a few hundred milliseconds.

If the /ping request is significantly delayed, it may indicate network throttling or regional limitations.

We currently offer two environments optimized for different regions. If you notice high latency, please switch based on your location:

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

Switching to the appropriate environment can significantly improve speed and stability.

If you're unsure which to use or still experience issues, feel free to contact us. We'll be happy to help.

🚦 Rate Limits & Quota

There are no general rate limits for API usage.

However, a few high-traffic endpoints may have specific rate restrictions (e.g., per minute/hour), which will be indicated in their respective documentation.

🛠 Support & Feedback

For any questions, integration support, or to request a custom solution, feel free to reach out via our support page:

👉 contact us

🔐 Authentication#

🚨 Response Handling & Error Codes#

Example Response#

Business Code Reference#

🐢 Latency Diagnostics#

🚦 Rate Limits & Quota#