API Gateway:
The platform is implemented with an API Gateway to streamline API traffic management. This will help to improve security by protecting API from unauthorized access, improve performance by managing load and ensure reliability by providing single point of failure.
Why Gateway:
To ensure fair usage policy across brands.
Your API requests will be throttled to 10 requests per second. Exceeding this limit, will result in HTTP error 429. Brands will have to handle the HTTP error 429 and ensure the requests are resent to TrusTrace for processing.
Rate Limit Response Headers:
You can check your current rate limit status by looking at the following HTTP headers which are returned in response to every API request.
ratelimit-limit: 10
ratelimit-remaining: 9
ratelimit-reset: 1
x-api-version: 3.1.0
Header Name | Description |
ratelimit-limit | Total number of API calls allowed per minute. |
ratelimit-remaining | The number of requests remaining in the current rate limit window. |
ratelimit-reset | The number in seconds in which the ratelimit-remaining will be reset to the ratelimit-limit value. |
| Note | The rate limiting operates at the brand level and not at the token level. This implies that if a brand has 2 API tokens and runs concurrent process to integrate with TrusTrace, the maximum rate limiting restriction for both tokens combined will be 10 requests per second. |