Índice

Como ativar a comunicação via API 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.

Conectando ao Banco do Brasil

  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-se: https://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.

  1. 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.

  1. 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. Saiba mais: Como ativar o PIX do Banco do Brasil?

No final da página clique em Criar.

  1. 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 ícone de 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.

Você só conseguirá concluir o fluxo se o CPF da sua conta do Portal de Desenvolvedor tiver poderes administrativos na conta da sua empresa. Caso contrário, o administrador deverá acessar o portal e autorizar o envio para produção antes de você concluir.

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.

  1. 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ções > Conexõ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.
  1. Associando a conexão à carteira

Por último, você deverá indicar qual carteira de cobrança utilizará essa conexão com o banco. Vá ao menu Cobrança > Configurações > Carteiras e, então, clique em Ativar na coluna web service da carteira correspondente.

Em seguida, selecione a conexão que você acabou de criar para concluir.

  1. Testando a conexão

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.

Ativando os webhooks

Com o sucesso da conexão acima, qualquer confirmação do banco (pagamento, cancelamento, alteração, etc) dependerá de uma consulta da Kobana que acontece de hora em hora. Para que essas confirmações ocorram em tempo real é necessário ativar os webhooks do banco. Para fazer isso, siga os passos abaixo:

  1. Solicitando a URL do webhook

Através do seu login, solicite em nosso chat na interface a URL correspondente ao webhook de cobranças.

  1. Acessando o Portal Developers do Banco do Brasil

Acesse o Portal Developers do Banco do Brasil com o seu login e senha: https://app.developers.bb.com.br/

Selecione a aplicação em produção que está conectada à Kobana.

No menu esquerdo que aparecerá, clique no sino, que representa a parte de webhooks.

Clique no botão Cadastrar Novo Evento.

Como neste artigo estamos tratando da parte de boletos, agora você vai selecionar a API de Cobranças.

Caso tenha interesse em utilizar para PIX, também, acesse este artigo: Como ativar o PIX do Banco do Brasil?

Selecione o convênio específico referente aos recebimentos das confirmações, inclua a URL disponibilizada pela nossa equipe para recebimento das notificações e o e-mail caso haja necessidade de um contato do banco.

Deixe o evento Baixa Operacional selecionado e defina o status dele como Ativado. Cliquem em Salvar para finalizar.

Como fizemos?

Formas de comunicação na gestão de boletos entre os bancos e a Kobana

Como ativar a comunicação via API de boletos do Itaú?

Contato