Overview

Welcome to the API documentation! On this page, you will find everything you need to know to improve the security and quality of your apps using our API.

Integration

The CAF API follows the REST standard. Therefore, our API has predictable resource-oriented URLs that accept and return data in JSON format while also using standard HTTP code in the response.

Responses

We use conventional response codes to indicate success or failure in a request. In short, codes in the 2xx range represent success. Codes in the 4xx range indicate validation error types with the information provided or mapped failures. Finally, codes in the 5xx range indicate an error with the servers or some other unforeseen failure.

In addition, all responses have an identifier for the request, the requestId field. This field is helpful for us to find the exact request in case of investigation.

Rate limiting

We've set API rate limits to protect CAF from API traffic spikes that could put our systems at risk. These limits also help ensure that our platform remains stable and usable for everyone. We evaluate the number of requests sent to an API and will throttle them if they surpass the allowed amount.

• Requests per second (RPS): 10,000

• Timeout: 30 seconds

• Payload size: 10MB