Autenticação

Gerenciamento de Token

Com o clinetId (API Key) e o secretKey (API Secret) é necessário fazer a gestão do token de acesso da sua aplicação.

Gerar um token utilizando ClientId e ClientSecret. Fluxo de geração de token descrito no passo abaixo. O token possui uma validade em segundos, apresentada no campo expires_in. /// 420 segundos em Sandbox e 300 segundos em Produção.

Token de Autenticação

Para usar a API é necessário obter o token Bearer de autenticação. Para e emissão do token de acesso reproduza os seguintes passos:

1.1 Realizar uma requisição Basic Auth no endpoint abaixo

1.2 Definir o valor client_credentials para o campo grant_type

1.3 Definir o valor desejado de acesso para o campo scope [Vide tabela Permissões abaixo]

1.4 Inserir ​​​​​​​clientId e ​​​​​​​clientSecret válidos no campo Authorization do Header

1.5 Utilizar token_type access_token no campo Authorization do Header na requisição dos endpoints da API.

POST /auth/oauth/v2/token

Exemplo - REQUEST

curl --location --request POST 'https://example.bancobonsucesso.com.br/auth/oauth/v2/token' \  
--header 'Authorization: Basic bDdkNWQ3OTg1ZDMxMTE0Y2NjYTgzMjlmZWVkZDQ3N2E0NTpmNjBjYzVjMzIxNDA0Y2UyOWQ4Mjg5NGVmNmEzZWI1Ng==' \  
--header 'Content-Type: application/x-www-form-urlencoded' \  
--data-urlencode 'grant_type=client_credentials' \  
--data-urlencode 'scope=cob.write cob.read dict.write dict.read webhook.read webhook.write pix.read pix.write'  

Exemplo - RESPONSE

{  
"access_token": "36ee37ec-a475-4068-8f6e-e08dd2b8880d",  
"token_type": "Bearer",  
"expires_in": 420,  
"scope": "cob.write cob.read dict.write dict.read webhook.read webhook.write pix.read pix.write"  
}  

Pontos Importantes

O campo expires_in representa a validade do token em segundos, enquanto o token estiver válido, este token deve ser utilizado.

Quando o token estiver próximo da validade, deve-se gerar um novo token, para assim, receber um novo token valido pelo mesmo período de tempo.

Não há limite de requisições enquanto o token estiver válido.

Quando um novo token é gerado, o token anterior passa a ser inválido.