APIs
Follow the links below to view the detailed API specs. To request an API access key, visit the products view.
Rate Limits
Clients are limited to a maximum of 100 requests per minute per API subscription key. This is intended to ensure quality of service for all clients using Bestpass APIs.
If a client exceeds the rate limit, the API will return an HTTP 429 Too Many Requests
response. This will include a Retry-After
header indicating how long to wait (in seconds) before the request should be retried. The body of the response will also include a similar message, e.g.
{
"statusCode": 429,
"message": "Rate limit is exceeded. Try again in 12 seconds."
}
Release Notes
Since the release of our REST platform in Q1 2023 we have received some great feedback and enhancement requests. The API team has deployed nearly all of those changes (and some we came up with on our own), with more on the way. Have a look at the release notes page.