Integração API Banco do Brasil

De Tek-System Wiki
Revisão de 12h44min de 31 de março de 2025 por Jairo Neto (discussão | contribs)
Ir para navegação Ir para pesquisar

APIs de Recebimento Banco do Brasil

Documentação para utilização das APIs de Cobrança do Banco do Brasil para permitir realizar envio e retorno de remessas bancárias sem utilizar a troca de arquivos, além da emissão de Bolecode e QRCode.

Bolecode

O bolecode é o meio de cobrança que utiliza as funcionalidades do recebimento por PIX e por Boleto no mesmo documento de pagamento.

O pagamento por QRCode é identificado de forma imediata pelo Banco do Brasil. Quando ocorre o pagamento por código de barras, o QRCode ficará indisponível.

Pix

O pagamento do QRCode é identificado de forma imediata pelo Banco do Brasil. A movimentação da conta ocorrerá no mesmo momento.

Credenciais

Será necessário solicitar ao gerente da conta no Banco do Brasil acompanhamento no processo de homologação nos ambientes de Produção/Homologação.

[Homologação] Sandbox

No portal do Banco do Brasil, deverá ser criado um cadastro para o cliente para ter acesso as informações das credenciais de homologação/produção.

 Acesse o Portal do Banco do Brasil: https://www.bb.com.br/site/developers/

Selecione a opção de CRIAR NOVA APLICAÇÃO;

  • Informe um nome para aplicação. Ex: Tek-System-Homologação. Tek-System-Produção;
  • Utilização do ícone da aplicação a logo da empresa;
  • Selecione as APIs contratadas. Para funcionamento completo do sistema: Cobranças; Pix; Extratos;
  • Finalize clicando em CRIAR.

Volte a tela principal do portal de desenvolvedor do Banco do brasil e entre na aplicação criada. Procure pela opção de Credenciais, será possível identificar os tokens utilizados para API.

Sandbox

  • developer_application_key
  • client_id
  • client_secret
  • Token: utilize a opção de COPIAR BASI

[Produção] API BB para Pix Recebimentos, Cobrança(Boletos) e Conta Corrente (Extrato)

Certifique-se de que todos os cenários foram testados em homologação. Somente clientes do BB podem gerar credenciais de produção.

 Acesse o Portal do Banco do Brasil: https://www.bb.com.br/site/developers/

Selecione a aplicação que deseja enviar para Produção;

  • Procure pela opção ENVIAR PARA PRODUÇÃO;
  • Insira o CNPJ da sua empresa e clique em Pesquisar CNPJ. O sistema irá exibir os detalhes da empresa selecionada. Verifique que todas as informações estejam corretas e, clique em Próximo;
  • Revise os dados de sua aplicação, e clique no botão "Solicitar produção";
  • A aplicação ficará em estado Aguardando aprovação e será gerada uma pendência de confirmação;
  • Para resolver a pendencia no Banco do Brasil, verifique a documentação: https://apoio.developers.bb.com.br/referency/post/663534f889ca2300139cc2cc

Produção

  • developer_application_key
  • client_id
  • client_secret
  • Token: utilize a opção de COPIAR BASI

Certificado Digital

Além das credenciais, será necessário a utilização de certificado digital.

As APIs do Banco do Brasil cujo fluxo de autenticação é client credentials, utilizam certificados digitais garantindo mais proteção à comunicação, autenticação e integridade na utilização dos serviços. Quando um certificado é assinado 
por uma autoridade de certificação confiável, quem possuir o certificado pode contar com a chave pública que ele contém para estabelecer uma comunicação segura com a outra parte. O padrão internacional x.509 provê a especificação para 
certificados de chave pública e proporciona uma solução de segurança mais completa, assegurando a identidade de todas as partes envolvidas em uma integração.

Verifique os passos para geração e configuração do certificado digital no Portal do Banco do Brasil para ambiente de Produção: https://apoio.developers.bb.com.br/referency/post/670eaa39646e2900126b6bdc

Configurações do Sistema

Necessário solicitar liberação da funcionalidade licenciada ao setor responsável: INTEGRACAO_API_BRASIL