Best Practices

Caching

To optimize performance and reduce unnecessary API calls, please cache the data retrieved from the API whenever possible. This helps prevent redundant requests for the same data and improves overall system efficiency.

Pagination

When querying data, use the page and pageSize query parameters to retrieve only the necessary amount of data. This approach prevents querying large datasets unnecessarily and ensures that the response size remains manageable, improving response time and reducing load.

Rate Limiting Policy

To maintain system stability and ensure fair usage, the API enforces rate limiting on incoming requests:

• Time Window: Requests are restricted within a predefined time window.

• Request Limit: A maximum number of requests can be made within this period.

• If the limit is exceeded, additional requests may be temporarily blocked until the time window resets.

This policy helps protect the system from excessive usage and ensures a smooth experience for all users.

Bulk Record Creation

For bulk data operations, ensure that requests are structured efficiently to minimize API load. Consider batching records into reasonable sizes rather than sending multiple individual requests. This will optimize performance and help avoid rate limit restrictions.

By following these guidelines, you can improve API performance, maintain efficiency, and ensure a seamless experience.