Como conectar à API de cobrança do Banco do Brasil?

Matheus Gonçalves Atualizada Por Matheus Gonçalves

Cada dia mais os banco estão evoluindo para que toda a comunicação seja realizada através de APIs. O Banco do Brasil já tem disponível uma API para cobrança, onde toda e qualquer informação referente aos boletos é enviada através dela.

Abaixo explicamos passo a passo como gerar as credenciais e conectar sua carteira cadastrada na Kobana com a API do Banco do Brasil.

Passo 1 - Criando sua conta no Portal Developers do Banco do Brasil

Para gerar as credenciais necessárias para a comunicação via API, você precisa criar a sua conta no Portal Developers do Banco do Brasil. Para isso, acesse o portal e clique em Cadastra-sehttps://developers.bb.com.br/home

Quando finalizar o cadastro e a confirmar o número de celular cadastrado, realize o login com a senha criada.

Passo 2 - Aceitando os termos de uso da plataforma

Em seguida ao login, você deverá concordar com os termos de uso da plataforma. Logo depois, você será direcionado para a tela de aplicações, onde deverá ter uma notificação no sino no canto superior direito, clique no sino.

A pendência que deverá aparecer é a de assinatura dos termos de utilização da API. Clique em Visualizar. Na próxima página leia os termos e marque que concorda, em seguida clique em Próximo para ler o termo seguinte, marque que concorda e clique em Concluir.

Passo 3 - Criando a aplicação

Retornando à tela de aplicações, você vai clicar no botão Nova Aplicação, onde você deverá preencher:

  • Nome da aplicação (ex.: "Nome da Empresa-API-Boleto")
  • Descrição (ex.: "Credenciais para conexão via API referente aos boletos")
  • Ícone da aplicação (você não precisa incluir nenhum ícone)
  • API: selecione a opção APIs com contratação online pelo Portal Developers BB e, então, Cobranças.
Na imagem acima, considere também selecionar o PIX, para que dessa forma você possa ter a opção de utilizar ambas as formas de cobrança na Kobana.

No final da página clique em Criar.

Passo 4 - Enviando para produção e gerando as credenciais

Com o seu novo aplicativo criado, clique nele e uma tela semelhante com a da imagem abaixo deverá aparecer. Clique no avião de papel na barra lateral esquerda para enviar seu app para produção.

Na próxima tela, preencha com o CNPJ da sua empresa e clique em Pesquisar CNPJ. O sistema irá exibir a identificação da empresa selecionada. Confira se a informação está correta e clique em Próximo.

Na página seguinte, revise os dados de sua aplicação e clique em Solicitar Produção. Na sequência, será exibido um Termo de Adesão, que deverá ser lido até o final. Se de acordo, efetuar a assinatura do mesmo. Ao efetuar a assinatura do Termo de Adesão, as credenciais de produção estarão habilitadas na área de Credenciais, e poderão ser visualizadas.

Passo 5 - Inserindo as credenciais na Kobana

De forma segura, copie as credenciais geradas (Client ID, Client Secret e Application Key) para aplicação e acesse sua conta na Kobana. Vá no menu IntegraçõesConexões. Crie uma nova conexão e selecione o Banco do Brasil. Dê um nome para a conexão, como, por exemplo "API COBRANÇA - BANCO DO BRASIL - NOME DA EMPRESA". Em seguida, selecione boleto como permissão da API e insira as credenciais até validar com sucesso a conta.

Caso você tenha selecionado no Portal de Desenvolvedores do Banco do Brasil a utilização do PIX, selecione também o PIX nesta área para que a conexão já ative os dois.

Recomendamos que, ao finalizar o processo, emita um boleto para testar o registro e verifique na aba de registro se o mesmo foi feito pela API. Acompanhe o próximo pagamento e verifique se ele veio sem a necessidade do arquivo de retorno.

Como fizemos?

Como ativar a comunicação via API com o Itaú

Contato