API Policy
Endpoint Deprecation
Our versioning at the endpoint level ensures a clear API lifecycle and effective change management, allowing for fine-grained deprecation of old endpoints and the introduction of new ones.
The version is indicated with a "vX" segment in the URL path, for Example:
/v1/.Deprecated endpoints will be removed no earlier than
3releases after their deprecation, providing consumers sufficient time to react and adapt to the changes.
Retry Policy
To ensure reliable communication, qibb's API Gateway has built-in retry handling for incoming HTTPS API requests for all qibb services and your flows. When the gateway detects a failed request, such as a timeout, server error or downtime, it catches the response and resends the request multiple times.
If any retry attempt succeeds, the gateway forwards the successful response to the client.
Component | Per try timeout The timeout for each retry | Number of retries The number of retries to execute for a failed request. | Retry on When to retry a failed request. |
|---|---|---|---|
qibb API services |
|
|
|
Flows |
|
|
|
Rate Limit Policy
Any API endpoint provided by qibb is safeguarded with rate limiting measures to enhance the availability and resilience of your services. If you exceed the rate limit for a particular service, you will receive a response containing Status code 429.
Rate Limit | |
|---|---|
qibb API services | 500 requests per IP per minute.* |
Flows | 500 requests per IP per minute.* |
Global | 1100 requests per IP per minute.* |
ULTIMATE
*For PaaS deployments (Ultimate Subscription), rate limit rules can be configured or disabled upon request to meet customer needs. Please contact our Support team.