Skip to main content

First steps

Prerequisites for Integration​

Integrating with the platform's APIs is a straightforward process.

This section presents the necessary steps for partners and developers to begin the integration securely and efficiently.

1. Obtain your access credentials​

After the contract is finalized and the initial onboarding process is complete, the credentials required to access the APIs will be provided.

These credentials are used to authenticate requests and identify the integrating application.

Each partner receives exclusive credentials, which must be stored securely in a secret vault or credential management system, avoiding exposure in source code or public environments.

Credentials are for the exclusive use of the partner and must be treated as sensitive information.

2. Use a tool to make HTTP requests​

To perform tests and validate the integration with the APIs, we recommend using tools that allow you to execute HTTP requests.

Some widely used tools are:

  • Postman
  • Insomnia

These tools allow you to:

  • Build HTTP requests
  • Send JSON payloads
  • Test authentication
  • Validate API responses
  • Simulate integration flows

To better understand the available environments for testing and staging, please refer to the Sandbox and Production Environments section.

3. Configure mTLS authentication​

Communication with the APIs uses mTLS (Mutual TLS) authentication, ensuring that both the client and the server are authenticated during the connection.

To perform the integration, you will need to:

  1. Generate the client certificate.
  2. Configure the certificate in your HTTP requests.
  3. Ensure that all API calls are made using a valid mTLS certificate.

This configuration ensures:

  • Authenticity of the integrating applications
  • Communication encryption
  • Protection against data interception

The complete configuration is detailed in the section: Authentication and Authorization (mTLS)

Integrate with the platform APIs​

Once credentials and mTLS authentication are configured, the application will be ready to consume the available APIs.

Each product has a specific section in this documentation containing:

  • Description of endpoints
  • Request parameters
  • Call examples
  • Response structure
  • Error codes