Breadcrumbs

Access the API Documentation

The Kubo API portal centralizes the API’s technical documentation, access credentials, and endpoints available for integration.

Through the portal, you can view the API reference and test endpoints directly using the interactive playground.

Instructions

Request access to the API documentation portal

Access to the API documentation is restricted to registered users. To request access, follow the steps below:

  1. Open a support ticket with Kubo
    After registering, you will receive an email with the subject Bem-vindo ao Portal de APIs Kubo - Configure seu acesso, from the sender Portal APIs Kubo LXP.

  2. Open the email you received and click the Ativar Minha Conta e Definir Senha button
    For safety reasons, the activation link is valid for 24 hours. If the link expires, you’ll need to request that support resend the invitation.

  3. On the Ativar sua conta screen, enter a password with at least 8 characters

  4. Confirm the password in the field below

  5. Click the Salvar Senha e Acessar Portal button

  6. Enter your email address and password

  7. Click the Access Portal button

Access the API documentation portal

After activating your account, follow the steps below to access the API documentation:

  1. Go to the API documentation portal

  2. Click the Acessar Portal button in the upper-right corner

  3. Enter your email address and password

  4. Click the Acessar Portal button

After logging in, the Visão Geral da API screen will appear, showing the available endpoints.

You can also navigate through the left-side menu to access a specific endpoint.

Perform authentication

Before testing any API endpoint, we recommend performing authentication:

  1. In the left-hand sidebar, click AUTENTICAÇÃO

  2. Click the POST Login (/v3/auth/login) endpoint

  3. In the senha field, enter the password used to access the API documentation portal

  4. Click the Try it out button

Once authentication is successful, the portal will display the request status and the returned token.

After successfully executing the login endpoint, the token is captured and saved in the session. With this, the other endpoints available in the left-hand sidebar can be tested as usual.

To do this, access the desired endpoint, enter the required parameters (if any), and click the Try it out button to execute the request.

The result will be displayed in the RESPONSE area, showing the request status and the data returned by the API.

Perform authentication