As APIs do produto de boleto híbrido são baseadas no protocolo OAuth2.0.

Para iniciar, vá em Primeiros Passos e cadastre as APIs do Boleto Híbrido que você deseja utilizar.

Gerar chave de acesso às APIs

Para realizar requisições nas APIs do Boleto Híbrido, é necessário gerar uma chave de acesso (access_token) por meio de uma requisição no endpoint de geração de token Gerando Access Tokens.

A validade da chave de acesso é obtida no objeto expires_in, em segundos.

É necessário que o parceiro realize a gestão da chave de acesso para garantir que todas as requisições nas APIs do Boleto Híbrido serão realizadas utilizando uma chave válida.

Gerar token

Para gerar o token, siga as instruções:

1. Com a API Key, API Secret e Scope prepare uma requisição HTTP do tipo POST para o endpoint Gerando Access Tokens;
2. No Body, utilize os valores recuperados da aplicação para preencher os parâmetros abaixo:
   1. client_id com valor de client_id;
   2. client_secret com valor de client_secret;
   3. scope com valor igual ao scope obtido junto às credenciais;
   4. grant_type com valor igual a client_credentials;
3. Realize a requisição e obtenha o access_token.

📝

Nota:

O access_token obtido na geração do token deverá ser utilizado nas demais requisições das APIs do Boleto Híbrido.