Este tutorial orienta as empresas no processo de criação das credenciais necessárias para a integração das APIs do Banco do Brasil com os sistemas da ONBOARD.

O processo é realizado pelo Portal Developers do Banco do Brasil, onde a empresa deverá criar uma aplicação, solicitar sua disponibilização em produção e obter as credenciais de acesso. Dependendo da API utilizada, também poderá ser necessário cadastrar um certificado digital para autenticação mútua (mTLS).

O responsável pela configuração deverá acessar o Portal Developers do Banco do Brasil. Caso ainda não possua um usuário, será necessário realizar o cadastro para acessar o portal.

Para criar o acesso:

1. Acesse o Portal Developers e clique em Entrar.

2. Informe o CPF e siga as etapas apresentadas na tela.

3. Informe os dados pessoais, endereço de e-mail e número de celular solicitados.

4. Valide o e-mail e o celular por meio dos códigos enviados pelo Banco do Brasil.

5. Cadastre uma senha de acesso.

O BB disponibiliza um guia detalhado para esse procedimento no Guia de acesso ao Portal Developers.

Após acessar o Portal Developers, será necessário criar uma aplicação para realizar a integração.

A aplicação é o recurso utilizado pelo Banco do Brasil para identificar a integração e disponibilizar as credenciais de acesso às APIs.

Para criar a aplicação, siga as orientações disponíveis no guia de criação de aplicações do Banco do Brasil.

Durante esse processo, selecione as APIs que serão utilizadas na integração.

Após criar e configurar a aplicação, será necessário solicitar o envio para o ambiente de produção.

Para isso, siga as orientações do guia de envio da aplicação para produção.

Após o envio da aplicação para produção, o dirigente responsável pela empresa deverá acessar o BB Digital PJ e autorizar a solicitação na aba Pendências.

A autorização pelo dirigente é necessária para que a aplicação possa ser disponibilizada em produção.

Após a autorização da aplicação pelo dirigente, o responsável poderá consultar as credenciais de produção da aplicação no Portal Developers.

As credenciais disponibilizadas pelo Banco do Brasil incluem informações como:

• Client ID

• Client Secret

Essas informações são utilizadas para autenticar a aplicação nas APIs do Banco do Brasil. O portal utiliza mecanismos de autenticação OAuth 2.0, e o fluxo utilizado pode variar de acordo com a API integrada.

Consulte o guia de credenciais do Banco do Brasil para obter as orientações atualizadas sobre a consulta das credenciais.

⚠️ Importante: o Client Secret é uma informação confidencial. Não compartilhe essa informação em canais não autorizados.

Algumas APIs do Banco do Brasil exigem, além das credenciais, a utilização de um certificado digital para autenticação mútua (mTLS). Nesses casos, o certificado deverá ser cadastrado na aplicação criada no Portal Developers.

Para verificar se a API utilizada na integração exige certificado mTLS, consulte a documentação específica da API.

Caso seja necessário, siga as etapas abaixo:

1. Acesse a aplicação criada no Portal Developers.

2. Na tela de Detalhes da aplicação, acesse a opção Certificados.

3. Clique em Enviar certificado, na seção Para consumir APIs.

4. Selecione o ambiente correspondente.

5. Envie o certificado seguindo as orientações apresentadas pelo portal.

O Banco do Brasil permite o envio da cadeia completa de certificados ou o envio individual dos certificados raiz, intermediário e da empresa. O certificado deve estar no padrão X.509, em codificação Base64.

Caso a empresa possua o certificado digital A1 em um arquivo PFX ou P12, não envie esse arquivo diretamente ao Banco do Brasil.

Esse tipo de arquivo pode conter tanto o certificado quanto a chave privada. Para o cadastro no Portal Developers, deve ser utilizada somente a parte pública do certificado.

O Banco do Brasil disponibiliza um guia para extração da chave pública de um certificado PFX.

⚠️ A chave privada do certificado é confidencial e não deve ser enviada ao Banco do Brasil nem compartilhada com terceiros.

Após concluir a configuração no Banco do Brasil, o responsável poderá realizar o cadastro das informações diretamente no BDOS por meio do Material de parametrização de métodos de pagamento.

Caso tenha dúvidas sobre o processo de cadastro ou parametrização, entre em contato com a equipe da ONBOARD por meio de um chamado no Jira.

Para auxiliar no processo de configuração do certificado digital, disponibilizamos abaixo um manual com as orientações para exportação e preparação do certificado A1 para utilização no Portal Developers do Banco do Brasil.

Caso a aplicação já tenha sido criada e as credenciais tenham sido geradas, mas a integração ainda não esteja funcionando, verifique se o certificado digital foi cadastrado corretamente no Portal Developers, quando exigido pela API.

Após o envio do certificado, o Banco do Brasil informa que pode ser necessário aguardar a internalização do certificado pelo sistema. O status do processamento pode ser acompanhado na tela de certificados da aplicação.