API rate limits

When you use an integration between vPlan and one or more other applications via our API, you also have to deal with API rate limits.

We want to keep the performance of vPlan optimal. Therefore, API rate limits apply to our API.

What are "API rate limits"?

Your integration communicates with our API platform. An API exchanges information through requests (messages with data) between vPlan and the software it is connected to (for example, Exact Online, AFAS or an own created connection). 

The number of messages can sometimes be high per day, which can affect the performance of vPlan.

To ensure that you can continue to make optimal use of our API, we are forced to set limits on the number of requests our API receives per day. This is normal practice for software companies with an API platform.

As of 1 September 2021, the limits will be set. Most integrations will not notice these limits, as they stay within 10,000 requests per day. Until then, you can already see how many requests your integration is using daily. Want to know how? You can find more information about rate limits on: https://developer.vplan.com/documentation/#section/Rate-Limits 

What does this mean for you?

First check how much your integration uses our API. You can do this by following the steps below when logged into vPlan:

1. In the left-hand menu bar of vPlan, go to Configuration
2. Then, from the left menu bar, go to Developers
3. Look under the heading Requests

The graph shows how many requests are sent to our API per day. Check the number of the highest peak in the graph.

Less than 5,000 requests per day?
Your integration is working fine.

No action needed.

Between 5,000 and 10,000 requests per day?
This is not a problem yet, the limit is 10,000 requests per day.
But your integration will be in the danger zone.

Do report this number to the party who developed your integration, and ask them to optimise the integration more.

More than 10,000:
Please note that this is a problem. We expect to enforce the limits on 1 September 2021.

Report this message to the party who developed your integration and ask them to optimise the integration.

If the integration cannot be optimised in time, please report this to support@vplan.com so we can look at the possibilities.