We are pleased to announce some adjustments to our previously communicated API limits changes, reflecting feedback from customers and partners.
In short:
- Later enforcement date (starting 1st of December 2024)
- Earlier opt-in available, for testing purposes
- More endpoints and ProcessXml requests designated as query requests
- Response time of a query will no longer affect API credits
- Simplification of API credits by using a different calculation method
- Clarification of returned headers and new headers added for more detail
- Working with customers and partners to adhere to the new limits
Enforcement date
The enforcement date will now commence on the 1st of December 2024 instead of 1st of October 2024, providing additional preparation time.
Opt-in for testing
An earlier opt-in option will be available for those interested in testing, this is intended to be available 1st of October 2024.
Query requests definition
We are expanding the number of endpoints and ProcessXml requests classified as query requests. Previously we communicated the following endpoints would count as ‘Query’ requests:
- HTTP GET Method calls
- HTTP OPTIONS Method calls
- Calls to the following endpoints:
- /webservices/DeletedTransactionsService.svc
- /webservices/*.svc where the SOAP action starts with ‘Get’ (header SOAPAction)
- /webservices/*.asmx where the SOAP action starts with ‘Get’ (header SOAPAction)
- ProcessXML requests with the following root elements:
We now added the following endpoints:
- Calls to the following endpoints:
- /webservices/*.svc where the action starts with ‘Query’, ‘Search’ and ‘Load’.
- /webservices/*.asmx where the action starts with ‘Query’, ‘Search’ and ‘Load’.
- ProcessXML requests with the following root elements:
- columns
- accountcode
- accountcodes
Impact of response time on API usage
We removed the API credit usage impact based on response time. Query requests that take longer than 1 second will be subject to the same rate limits as faster requests.
API credits
We will simplify the API credits system with a new calculation method that we believe will be more transparent and easier to understand. Instead of explicit requests per minute we will define API credits. Query requests as defined above will cost 1 API credit, and ‘Other requests’ will cost 3 API credits. This also simplifies the data that is returned in the headers, and allows slightly more ‘Other requests’ than previously defined.
|
Per IP Address
|
1000 API credits per minute
|
|
Per ClientId
|
1000 API credits per minute
|
|
Per OrganisationId
|
1000 API credits per minute
|
|
Per ClientId and OrganisationId combination
|
500 API credits per minute
|
HTTP Headers
The initially defined headers did not provide sufficient information to determine what limits were running out. Headers will be added to indicate the used API credits for only the ClientId specifically: X-RateLimit-ClientId-Limit, X-RateLimit-ClientId-Remaining.
The previously defined headers 'X-RateLimit-Limit' and 'X-RateLimit-Remaining' will return the lowest counter left on all limits (IP address, ClientId, Organisation, ClientId-OrganisationId combination).
Transition period
We are committed to work closely with our partners and customers to facilitate the adoption of new API limits, ensuring a seamless transition. In case of any questions, issues, or feedback, please reach out through your point of contact.
Related articles:
