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.

Important Notice about Integrations

To ensure the stability and security of our services, it is mandatory to implement integrations with Caf APIs exclusively via backend/server-side, as frontend calls (via browser or client-side) may be blocked by our systems when multiple IPs or browser user agents are detected. Furthermore, client-side integrations expose authentication keys to the risk of leakage and malicious use, which may lead to unauthorized resource consumption and additional charges. Authentication keys found to be used in incorrect implementations will be immediately deactivated.

We always recommend: (1) implementing on the backend, (2) using proper headers and authentication, and (3) never exposing credentials on the client-side. Please refer to our documentation for details or contact our technical support team.

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.