Our API follows REST principles, ensuring efficient and standardized communication.
We use HTTP verbs to define operations on resources and status codes to indicate the result of requests.
All responses are formatted in JSON.
HTTP Verbs
The table below describes the main HTTP verbs used in our API.
| Attribute | Description | Usage Example |
|---|---|---|
| GET | Retrieve information about a resource | Search for a user |
| POST | Create a new resource | Create an order |
| PUT | Update an existing resource | Update a product |
| DELETE | Remove a resource | Delete a client |
Status Codes
Interactions between your application and our API can result in three scenarios:
| Category | Description |
|---|---|
| 2xx – Everything worked | The request was successful. |
| 4xx – Something went wrong | The request contained invalid or incorrect information. |
| 5xx – The API did something wrong | An internal error occurred on the server. |
The following table presents the main status codes returned by the API, along with their error messages:
| Code | Message | ]Description | Meaning |
|---|---|---|---|
| 200 | OK | The request was successful. | - |
| 201 | Created | The resource was successfully created. | - |
| 400 | Bad Request | The request is malformed or incomplete. | Required parameter is missing or invalid. |
| 401 | Unauthorized | Authentication failed. | Invalid or missing access token. |
| 403 | Forbidden | Access to the resource is not allowed. | You do not have permission to access this resource. |
| 404 | Not Found | The requested resource was not found. | The requested item does not exist. |
| 500 | Internal Server Error | Internal error on the API server. | An unexpected error occurred on the server, please try again later. |
If a request fails, the API will return a 4xx or 5xx code, along with a JSON response.