Rate limit
To ensure the stability of the Genstore platform, rate limits are enforced on all REST API requests. Developers must understand these restrictions and use standard technical methods to prevent rate limit violations.
WARNING
Strictly adhere to API rate limits to ensure reliable service. Avoid using these APIs in customer-facing apps to prevent service interruptions caused by exceeding rate limits.
Rate limit policies
The following table outlines the rate limiting policies for various types of APIs, encompassing standard, advanced, and enterprise-level restrictions:
| Business Plan | API Type | Limitation Type | Standard Rate Limit Policy |
|---|---|---|---|
| Genstore Basic Plan | REST API | Request limit | Bucket size: 40 Refill rate: 4 per second |
| Genstore Standard Plan | REST API | Request limit | Bucket size: 200 Refill rate: 20 per second |
| Genstore Advanced Plan | REST API | Request limit | Bucket size: 400 Refill rate: 40 per second |
Rate limit mechanism
Genstore manages API request rates using the token bucket algorithm, detailed as follows:
- Initial bucket size: Each app at each shop starts with 40 tokens.
- Token consumption: Each request consumes one token.
- Token replenishment: When the token count falls below 40, the system replenishes at a rate of 2 tokens per second until the bucket is full again.
- Handling over-limit requests: If the bucket runs out of tokens, any new requests will receive a
429 Too Many Requestsstatus code, indicating that the rate limit has been reached.
Response header
Developers can monitor their API usage through the X-Genstore-Shop-Api-Rate-Limit field in the response headers:
X-Genstore-Shop-Api-Rate-Limit: 30/40This example shows that 30 requests have been made, leaving 10 tokens remaining. If no further requests are made, the bucket will gradually refill to full capacity (40/40) within approximately 15 seconds, assuming a replenishment rate of 2 tokens per second.