Frequently Asked Questions
Will our API-user be throttled?
Yes.
For each 5-second window, you are allowed 2 seconds of requests (from Flow starts processing until the request is finished). Going above this limit adds 1000ms + 500ms * ln(number of requests after the limit)
Example: Performing 4 requests, each taking 500ms of processing time, and then starting a new request would add a delay of 1000ms + 500ms * ln(1) = 1 second to the 5th request.
The system continues to add 500 ms throttling, until the upper limit of 150 requests within the 5-second window is reached, and then returning HTTP 429. Performing the maximum allowed number of requests after the limit is reached would add a 1000ms + 500ms * ln(149) = 3500ms delay.
After the closing of the 5-second window, the user will no longer be throttled.
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?
Swagger.
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 integration environment, integration.webtopsolutions.com you can whitelist: 20.251.211.57.
For production IP Address, please contact us.