Passar para o conteúdo principal

Como criar uma conexão com a API do Banco do Brasil?

Entenda como fazer a conexão com a API do Banco do Brasil para habilitar as operações.

Thiago Savelli avatar
Escrito por Thiago Savelli
Atualizado há mais de um mês

Cada dia mais, os bancos estão evoluindo para que toda a comunicação seja realizada via APIs.

Neste artigo, explicamos passo a passo como gerar as credenciais e como criar a conexão entre a Kobana e a API do Banco do Brasil.

1. Crie ou acesse 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, caso ainda não tenha. Para isso, acesse o portal e clique em Cadastra-se: https://developers.bb.com.br/home

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

2. Aceite 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, em que deverá ter uma notificação no sino no canto superior direito. Clique no sino.

A pendência que deve 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 vá em Concluir.

3. Crie a aplicação

Ao retornar à tela de aplicações, você vai clicar no botão Nova Aplicação e, então, deverá preencher:

  • Nome da aplicação (ex.: "Nome da Empresa-API-Kobana");

  • Descrição (ex.: "Credenciais para conexão via API com a Kobana");

  • Í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;

  • Escolha as opções de escopo referente às operações que pretende fazer na Kobana, como Cobrança, para a emissão de boletos, e Pix.

Recomendamos escolher todas as opções disponíveis, para que não seja necessário criar uma nova conexão futuramente.

No final da página, clique em Criar.

4. Envie para produção e gere as credenciais

Com o seu novo aplicativo criado, clique nele e uma tela semelhante a da imagem abaixo deverá aparecer. Acesse o í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. Assine se estiver de acordo.

Ao assinar o Termo de Adesão, as credenciais de produção estarão habilitadas na área de Credenciais, e poderão ser visualizadas.

Atenção! As credenciais só podem ser vistas no momento em que são geradas. Por isso, recomendamos anotá-las em um local seguro. Se você perdê-las, será necessário criá-las novamente.

5. Insira as credenciais na Kobana

De forma segura, copie as credenciais geradas (Client ID, Client Secret e Application Key) e acesse sua conta na Kobana.

Vá no menu Integrações > Bancos e serviços > API > Configurar Nova e selecione o Banco do Brasil.

Na tela seguinte, dê um nome para a conexão, como: "CONEXÃO - BANCO DO BRASIL - NOME DA EMPRESA". Abaixo, selecione as permissões da API, que indicam quais operações são possíveis com aquela conexão. Recomendamos escolher todas as opções possíveis, mesmo que não pretenda usá-las nesse momento. Assim, não será preciso criar uma nova conexão futuramente.

Além disso, você também precisa escolher o ambiente, lembrando que o de homologação é apenas para testes. Caso queria usá-lo, será preciso refazer o processo em produção.

Para finalizar, você precisa preencher as informações de identificação que criamos acima, o client ID, client Secret e Application Key. No certificado, escolha o mesmo que você usa no Banco do Brasil. Clique em Salvar para continuar.

Para finalizar, na próxima tela, clique no botão Validar conexão para o sistema verificar que está tudo funcionando perfeitamente.

Com a conexão criada, você pode configurar cada operação que quiser usar. Atualmente, no Banco do Brasil, você pode fazer as seguintes operações:

Respondeu à sua pergunta?