API Usage Considerations

​

Sandbox Environment

The SANDBOX Environment is specifically designed for you to explore, test, and interact with the latest features in a controlled environment. This branch provides a way for clients to test our solution and use it for integrating with their own system. To access our sandbox environment, refer to Client Onboarding.

​

Rate Limits

OmniOmni enforces rate limits on the API to ensure that no single organization consumes too many resources. Rate limits are applied to the organization, and not to the API key. In the sandbox environment, rate limits are enforced for non-GET endpoints and are set at 3000 requests per 10 minutes. If the rate limit is exceeded, the API returns a 429 Too Many Requests response.

​

Idempotency

Idempotency in REST calls is a crucial principle that guarantees a request can be repeated without altering the outcome. This is especially vital in distributed systems where network failures or timeouts might cause requests to be retried. Each non-GET method in our API manages idempotency in its own way, using unique identifiers (such as email, transfer-key, etc.). We ensure that requests are not processed more than once on the server, and if the data already exists, the response is generated from the existing data.

​

Error Handling

In the event of an error, our API response not only includes the standard HTTP status code, but also a detailed JSON object. This JSON object contains the HTTP status, an error-specific code, and a descriptive message providing additional context about the server error. This approach helps clients to easily understand the nature of the error and take appropriate action.