Frequently Asked Questions
Will our API-user be throttled?
Yes.
Every ClientId has a bucket that has a maximum of 3000 (default value) “tokens”. The bucket gets refilled by 1000 tokens (default) every 1 second (default).
When you do a request it removes tokens from the bucket:
- Default cost for any API method is 25 tokens
- Many API methods has a higher value (hard coded based on statistics)
- When the number of tokens in the bucket go below 750 requests will be delayed by the same formula.
The following headers can be used handle throttling:
| Header Name | Description |
|---|---|
| Retry-After | Describes in how many seconds you’re allowed to make a new request after getting a 429 response. |
| X-RateLimit-Delayed-By-Milliseconds | Describes how many milliseconds your request was delayed in order to reduce load. |
| X-RateLimit-Limit | Total number of requests allowed within a time window. |
| X-RateLimit-Remaining | The number of requests used within the current time window. |
| X-RateLimit-Reset | When the current time window ends. |
Which endpoints can we use?
Scalar.
The list of all available endpoints is too large to feasibly fit into and explain in this documentation, so navigate to any of our sites and add /flow:
https://{environment}.webtopsolutions.com/flow
How can I get an API user?
Contact us.
For this we will need a written confirmation from customers that would like to use your product. A request for API-users can then be sent to our support.
To make this process faster:
- include which auths your user needs or endpoints you plan to use.
- general questions not covered in the documentation ( so we can add it )
- please search the documentation for an answer before you contact us
We need to whitelist your IP addresses, what are they?
Integration environment IP
To ensure communication with our environments, whitelist the following IP addresses:
- 20.100.15.55 - All test environments.
- 20.251.211.57 - All production environments.
AI Assistant (Beta)