Introduction

Welcome to our functional documentation exhibition area! This is a dedicated space for developers like you who are looking to consume our APIs.

Here, you will find a variety of detailed and up-to-date documentation covering all aspects of our APIs. Each document has been carefully crafted to provide a clear and concise overview of each API's functionality, parameters, expected responses, and potential errors.

Our mission is to make your job easier and ensure you have all the information you need to successfully integrate our APIs into your projects. We are committed to providing you with a smooth and efficient development experience.

Explore, learn and create with confidence. We look forward to seeing what you build!

Authentication

The APIs authentication is carried out with information of a pair of tokens on the requests header. The following pair of tokens is expected in each request:

client_id: APP Identification. Its generation occurs at the moment of APP creation, through the developer dashboard. Its value can be viewed on the Token column of the APPs list, and it can be used both in the Sandbox and in the Production environment, after the application undergoes the validation process.

access_token: Access token identification, which stores the allowed access rules to APP. Its generation occurs in two moments during the process of integration with APIs.

Status Codes

Code Error Description
200 OK

The request has succeeded.
400 Bad Request

The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
401 Unauthorized

The request requires user authentication.
404 Not Found

The server has not found anything matching the Request-URI.
413 Request is to Large

The server is refusing to process a request because the request entity is larger than the server is willing or able to process.
422 Unprocessable Entity

The request has business mistakes.
429 Too Many Requests

The 429 status code indicates that the user has sent too many requests in a given amount of time ("rate limiting").
500 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request.
English