Rate Limits - vPlan

The RateLimit headers are sent in responses to all the Api-Key and OAuth requests. They contain information about the amount of requests that can be made within a specified time window.

Header	Description
RateLimit-Limit	Maximum number of requests you're permitted to make per time window.
RateLimit-Remaining	Number of requests remaining in the current rate limit window.
RateLimit-Reset	Time at which the current rate limit window resets in seconds.

Tips for optimizing an integration:

Use webhooks to be signaled when a certain event is triggered, instead of synchronizing every X minutes

Increase the interval between synchronizations, for example every 30 minutes instead of every 10 minutes

Create an Order with OrderRows in one request instead of separate requests per OrderRow

Use Eager loading, for example the Relation or Project info can be included when getting an Order in one request

Reduce retrieval of data.

Try not to fetch after an update when the updated fields are known

Use Show & Hide to fetch less data

Utilize Pagination, Filtering and Sorting to only fetch what you need

When an objects needs to be updated or referenced in another call, having the information available without having to retrieve it every time, can drastically reduce request counts.

Possible options are:

Store vPlan ids

Store entire vPlan objects

Cache vPlan ids

Cache entire vPlan objects