How long a request can run, how to raise the limit for bulk work, and where requests are logged.
API Throttling#
There is no throttling enforced on API requests. To the server it will appear just like any other http request. Miva will process the request and then return the results back to the client. This does mean that the burden is placed on the developer doing any integration to prevent API requests, inadvertently causing a Denial Of Service attack, because a client made too many API requests.
API Timeouts#
The API uses the same timeouts defined the the Miva’s stores mivavm.conf file. These are the global timeouts used across any Miva page for each site. Default timeout in most Miva stores is 60 seconds. You can also increase this timeout when doing bulk transactions on a per request basis by passing the following header:
X_MIVA_API_TIMEOUT
For example lets say you need to push up a big block of tracking numbers using our multicall format, you can pass this header to be a value greater than 60 seconds to avoid a timeout.
Logging#
API requests are not logged separately against regular requests. The server’s access logs can be used to help troubleshoot any API related issues.