API Throttle

How our API Throttle works

To ensure continuous quality of service, API usage can be subjected to throttling. The throttle will be applied once an API client reaches a certain threshold. Zaui Software reserves the right to throttle any and all API clients to ensure quality of service for all Zaui Software customers. Those clients who do encounter a throttle threshold will get met with an HTTP 503 response code and the error XML node populated. We encourage all API developers to anticipate this error and take appropriate measures like:

  • using a cached value from a previous call, or

  • passing on a message to the end-user that is subjected to this behavior (if any)

  • implement exponential back-off in your logic (see below)

Before starting, any organization wishing to use this API must have been provided authentication credentials.

Last updated