API Banco do Brasil: mudanças entre as edições

VisualWikitexto

Edição atual tal como às 15h13min de 20 de fevereiro de 2024

Passo a passo de como fazer o cadastro para utilizar as APIs do Banco do Brasil.

1° Passo - Criar conta no BB For Developers

Criar uma conta no BB For Developers. Acessar Link: https://www.bb.com.br/site/developers/

2° Passo - Clicar em Cadastra-se

3° Passo - Tela Inicial Conta

Com a conta no site criada, você será redirecionado para a tela dos dados dos aplicativo ativos que você possui.

Para o próximo passo basta selecionar o aplicativo, no meu caso é o "Teste cobrança". Mas como será o seu primeiro acesso basta clicar em "Nova Aplicação". Você será redirecionado para a tela de criação de uma nova aplicação, basta informar os dados (Nome, Descrição e icone. Icones são opcionais).

Logo abaixo você deve selecionar quais APIs o seu aplicativo ira obter, os aplicativos podem possuir APIs de cobranças ou pagamentos.

Com o aplicativo selecionado basta ir na barra de menus no canto esquerdo.

Para obter as credenciais para poder realizar os testes ou até mesmo as credencias de produção, basta clicar em credenciais.

4° Passo - Acessar Documentação e Ambiente de Teste

Para acessar a documentação ou ambiente de teste, basta voltar para o Dashboard inicial clicando na barra de menus ao lado esquerdo e ir em "Dashboard". No Dashboard basta ir em "Documentação" ou "SandBox" (Para o ambiente de teste).

Ao clicar em "Documentação", para obter os dados de teste, basta ir ao menu lateral esquerdo e clicar em "API Cobrança -> Homologação e testes" (Dados da API de cobrança) por exemplo.

Ao acessar essa aba ao rolar para baixo você tem acesso aos dados fictícios, como também, exemplo de como montar a requisição.

Ao clicar em "SandBox", para obter acesso ao ambiente de testes do Banco do Brasil, basta ir ao menu lateral esquerdo e clicar em "API'S" e escolher a API que deseja testar, você pode utilizar o ambiente de testes para entender o processo ou ir direto ao ERP.

Ao clicar em "Cobrança" por exemplo, a tela abaixo será exibida:

Porém, antes de utilizar a API você precisa Autorizar as suas credenciais, basta clicar em "Authorize":

Basta informar o seu Client-Id e Client-Secret e selecionar os escopos a ser utilizado, pode selecionar os dois escopos, pois será necessário para utilizar nos testes. Após isso basta autorizar.

5° Passo - Produção

Para colocar a aplicação em Produção basta ir na barra de menus no canto esquerdo e clicar em Produção.

Ao clicar a tela de inicio para colocar o aplicativo em produção será exibida, basta seguir os passos.

6° Passo - Configurar WebHook ERP

Para o funcionamento do webhook é necessário algumas informações no ERP:

Informar o número de convenio da conta e também a quantidade de dias acordada na contratação do convenio para a data de crédito, considerando feriados e finais de semana.

É necessário informar no cadastro de banco o código da ocorrência que vai ser utilizada para a baixa operacional das cobranças recebidas no evento do webhook:

Já nas informações da aplicação, é preciso informar as informações do banco de dados para funcionamento da aplicação, que se encontra na pasta XmlConfig no arquivo WH_DpSettings.xml:

Já no arquivo web.config é preciso parametrizar o caminho do arquivo de configurações e também aonde o arquivo de log será gerado, e um usuário para ser utilizado no log de alterações do movimento que será gerado:

7° Passo - Configurar WebHook Banco do Brasil

Na plataforma do Banco do Brasil é preciso seguir os seguintes passos:

Entrar no aplicativo, clicar no menu lateral esquerdo em webhook:

Clicar em Cadastrar Evento e inserir as informações necessárias para o funcionamento, assim como escolher a API a ser utilizada, o convenio, a URL de callback e o email para notificações de problemas e o tipo de evento.

Segue os IPs externos utilizados pelo Webhook dos 2 datacenters do banco do brasil:

  CCT1: 170.66.14.184
  CCT2: 170.66.196.181 / 170.66.196.114 - 115

@@ Linha 1: / Linha 1: @@
-Passo a passo de como fazer a integração na API de Cobrança. O exemplo será utilizado com base na API do Banco do Brasil.
+Passo a passo de como fazer o cadastro para utilizar as APIs do Banco do Brasil.
-== 1° Passo - Criar conta Gmail ==
+== 1° Passo - Criar conta no BB For Developers ==
-Criar uma conta no Gmail, ou utilizar a existente
+Criar uma conta no BB For Developers.
+Acessar Link: https://www.bb.com.br/site/developers/
-== 2° Passo - Acessar Link ==
+== 2° Passo - Clicar em Cadastra-se ==
-Acessar o link: https://console.cloud.google.com/getting-started
+[[Arquivo:Cadastro BB.png|centro|Tela de Cadastro BB for developers]]
-[[Arquivo:1 - inicio.png|centro]]
+== 3° Passo - Tela Inicial Conta ==
+Com a conta no site criada, você será redirecionado para a tela dos dados dos aplicativo ativos que você possui.
-== 3° Passo - Criar um projeto ==
+[[Arquivo:Tela do aplicativo.png|centro|Tela de dados do aplicativo]]
-Clicar em Select Project - Para criar um projeto e depois em New Project
+Para o próximo passo basta selecionar o aplicativo, no meu caso é o "Teste cobrança". Mas como será o seu primeiro acesso basta clicar em "Nova Aplicação".
-[[Arquivo:2 - criarprojeto.png|centro]]
+Você será redirecionado para a tela de criação de uma nova aplicação, basta informar os dados (Nome, Descrição e icone. Icones são opcionais).
+[[Arquivo:Cadastro nova aplicação.png|centro|Cadastro nova aplicação]]
-Nomear o projeto com o nome de preferência
+Logo abaixo você deve selecionar quais APIs o seu aplicativo ira obter, os aplicativos podem possuir APIs de cobranças ou pagamentos.
-[[Arquivo:3 - nomeprojeto.png|centro]]
+[[Arquivo:Apis para aplicação Cobrança.png|centro|Apis para aplicação cobrança]]
-== 4° Passo - Tela consentimento OAuth ==
+[[Arquivo:Apis para aplicação pagamento.png|centro|Apis para aplicação pagamento]]
-Ir para APIS & Serviços - Tela de Consentimento OAuth
-[[Arquivo:4 - oauth.png|centro|oauth]]
+Com o aplicativo selecionado basta ir na barra de menus no canto esquerdo.
-Escolha o projeto que será feito a autorização do OAuth
+[[Arquivo:Barra de menus BB.png|centro|Barra de menus do aplicativo BB]]
-[[Arquivo:5 - projoauth.png|centro]]
-Com o projeto selecionado, configurar o tipo para externo
+Para obter as credenciais para poder realizar os testes ou até mesmo as credencias de produção, basta clicar em credenciais.
-[[Arquivo:6 - configoauth1.png|centro]]
+[[Arquivo:Credenciais de teste dados ocultos.png|centro|Credenciais de teste dados ocultos]]
-Definir um nome para o aplicativo e o email de suporte, é aconselhável que o nome do aplicativo seja o mesmo que o nome do projeto
+== 4° Passo - Acessar Documentação e Ambiente de Teste ==
-[[Arquivo:7 - configoauth2.png|centro]]
+Para acessar a documentação ou ambiente de teste, basta voltar para o Dashboard inicial clicando na barra de menus ao lado esquerdo e ir em "Dashboard". No Dashboard basta ir em "Documentação" ou "SandBox" (Para o ambiente de teste).
+[[Arquivo:Dashbord toolstrip BB.png|centro|Dashboard]]
-Logo abaixo, é preciso definir o email do desenvolvedor ou responsável pela implantação do projeto e prosseguir
+Ao clicar em "Documentação", para obter os dados de teste, basta ir ao menu lateral esquerdo e clicar em "API Cobrança -> Homologação e testes" (Dados da API de cobrança) por exemplo.
-[[Arquivo:8 - configoauth3.png|centro]]
+[[Arquivo:Barra lateral documentação.png|centro|Homologação e teste]]
-Em escopos clique em "Adicionar ou remover escopos"
+Ao acessar essa aba ao rolar para baixo você tem acesso aos dados fictícios, como também, exemplo de como montar a requisição.
-[[Arquivo:Adicionar escopos.png|centro]]
+[[Arquivo:Dados ficticios documentação.png|centro|Dados ficticios documentação]]
-Na janela que abrir ao lado direito, no campo "Adicionar escopos manualmente", digite "https://www.googleapis.com/auth/drive.file" e clique em "Adicionar à tabela"
+[[Arquivo:Dados ficticios requisicao.png|centro|Dados ficticios requisicao]]
-[[Arquivo:Adicionar escopo tabela.png|centro]]
-Com o escopo adiciona a tabela você pode visualizar que um valor nos filtros está marcado:
+Ao clicar em "SandBox", para obter acesso ao ambiente de testes do Banco do Brasil, basta ir ao menu lateral esquerdo e clicar em "API'S" e escolher a API que deseja testar, você pode utilizar o ambiente de testes para entender o processo ou ir direto ao ERP.
-[[Arquivo:Escopo adicionado na tabela.png|centro]]
-Depois disso basta clicar em atualizar e as informações do "Escopos não confidenciais vai ser atualizada":
+[[Arquivo:Barra Lateral SandBox.png|centro|Barra Lateral SandBox]]
-[[Arquivo:Escopos não confidenciais.png|centro]]
-Depois disso basta salvar e continuar até o "Resumo" e voltar ao painel inicial
+Ao clicar em "Cobrança" por exemplo, a tela abaixo será exibida:
+[[Arquivo:Ambiente de teste api bb.png|centro]]
-== 5° Passo - Publicar Projeto ==
+Porém, antes de utilizar a API você precisa Autorizar as suas credenciais, basta clicar em "Authorize":
-Com o consentimento configurado basta publicar o projeto:
+[[Arquivo:Tela de autorização sandbox.png|centro|Tela de autorização SanxBox]]
-[[Arquivo:Publicar projeto.png|centro]]
-'''Importante:
+Basta informar o seu Client-Id e Client-Secret e selecionar os escopos a ser utilizado, pode selecionar os dois escopos, pois será necessário para utilizar nos testes. Após isso basta autorizar.
-A partir de 2021, o Google fez uma alteração que fará com que todos os tokens de atualização expirem após sete dias se o projeto que o criou ainda estiver em fase de teste. A solução é alterar seu projeto para produção e, assim seus tokens de atualização durarão mais de sete dias.
-== 6° Passo - Biblioteca de APIs==
+== 5° Passo - Produção ==
-Após baixar o arquivo, clicar em Biblioteca
+Para colocar a aplicação em Produção basta ir na barra de menus no canto esquerdo e clicar em Produção.
-[[Arquivo:16 - library.png|centro]]
+[[Arquivo:Produção.png|centro|Colocando o aplicativo BB em produção]]
-Pesquisar por "Google Drive" e ativar a API
+Ao clicar a tela de inicio para colocar o aplicativo em produção será exibida, basta seguir os passos.
-[[Arquivo:Api google drive.png|centro]]
-Pesquisar por Google+
+[[Arquivo:Inicio da produção.png|centro|Inicio da produção para o aplicativo BB]]
-[[Arquivo:17 - libraryapi.png|centro]]
-Selecionar Google+ API
+== 6° Passo - Configurar WebHook ERP ==
-[[Arquivo:18 - googole+.png|centro]]
-== 7° Passo - Configurar credenciais ==
+Para o funcionamento do webhook é necessário algumas informações no ERP:
-Com o autorização do OAuth concluída e com o projeto publicado, ir em Credenciais - Criar Credenciais
-[[Arquivo:10 - configcredenciais.png|centro]]
+[[Arquivo:Parametros webhook Conta.png|centro]]
-Clicar em Cliente Id OAuth
+Informar o número de convenio da conta e também a quantidade de dias acordada na contratação do convenio para a data de crédito, considerando feriados e finais de semana.
-[[Arquivo:11 - keyoauth.png|centro]]
-Definir o tipo de aplicação como "Para Computador", definir um nome e Criar
+É necessário informar no cadastro de banco o código da ocorrência que vai ser utilizada para a baixa operacional das cobranças recebidas no evento do webhook:
-[[Arquivo:13_-_configketoauthnome.png|centro]]
-Credenciais criadas do OAuth, basta clicar em "Download JSON"
+[[Arquivo:Parametros webhook banco.png|centro]]
-[[Arquivo:14 - keysoauth.png|centro]]
-Um arquivo Json com as credenciais será baixado na máquina
+Já nas informações da aplicação, é preciso informar as informações do banco de dados para funcionamento da aplicação, que se encontra na pasta '''XmlConfig''' no arquivo '''WH_DpSettings.xml''':
-[[Arquivo:15 - arqokeys.png|centro]]
-'''Com o consentimento do OAuth configurado, as credenciais geradas e as APIs necessárias ativadas, basta ir até o ERP
+[[Arquivo:Informações banco de dados xml de configurações webservice.png|centro]]
-== 8° Passo - Configurar no ERP ==
+Já no arquivo '''web.config''' é preciso parametrizar o caminho do arquivo de configurações e também aonde o arquivo de log será gerado, e um usuário para ser utilizado no log de alterações do movimento que será gerado:
-Para configurar no ERP, é preciso ir em Configurações -> Configurações de Integração
-[[Arquivo:21 - erp-config.png|centro]]
+[[Arquivo:Arquivo webconfig parametrização valores.png|centro]]
-Ir até a aba Google Drive
+== 7° Passo - Configurar WebHook Banco do Brasil ==
-[[Arquivo:22 - configgoogledrive.png|centro]]
-Para autorizar a API basta clicar no botão "Autorizar API" e importar o arquivo Json que foi baixado, se uma janela do navegador abrir solicitando que você informe se o aplicativo que está solicitando é confiável, basta permitir o acesso. Após o processo de autenticação uma mensagem de sucesso será exibida, e as chaves Cliente Id, Chave Secreta, Token de acesso e Token Atualizado serão importados para a tela, é preciso que ao preencher os dados como (ClienteId, Chave Secreta, Id Pasta, Email, Token Acesso, Token Atualizado) salva-los e retornar para a tela novamente para prosseguir com a criação da pasta.
+Na plataforma do Banco do Brasil é preciso seguir os seguintes passos:
-[[Arquivo:23 - acessoautorizadoapi.png|centro]]
-Para criar uma pasta que será armazenado os arquivos, o usuário pode criar manualmente no Google Drive ou pode clicar no botão, uma mensagem será exibida, permitindo o usuário criar uma pasta com nome de preferência ou com o nome padrão "DataPlus"
+Entrar no aplicativo, clicar no menu lateral esquerdo em webhook:
-[[Arquivo:24 - criarpasta.png|centro]]
-'''Atenção: Caso alguma mensagem de erro seja apresentada durante o processo de criação da pasta é necessário aguardar algumas horas após a ativação da API, para que ela seja liberada para uso
+[[Arquivo:Menu lateral aplicativo bb.png|centro]]
-[[Arquivo:25 - msgerro.png|centro]]
+Clicar em '''Cadastrar Evento''' e inserir as informações necessárias para o funcionamento, assim como escolher a API a ser utilizada, o convenio, a URL de callback e o email para notificações de problemas e o tipo de evento.
-== 8° Como testar a classe ==
-Você irá precisar ter as credenciais com o "Client Id" e a "Client Secret" e fazer a autenticação para coletar o "Refresh Token" e o "Access Token", depois você vai precisar informar o "Nome do Aplicativo" o "Email" e o "Id da Pasta".
-Última atualização: 20/06/2023
+Segue os IPs externos utilizados pelo Webhook dos 2 datacenters do banco do brasil:
+   CCT1: 170.66.14.184
-== 9° Principais Métodos ==
+   CCT2: 170.66.196.181 / 170.66.196.114 - 115
-*'''GetService()''' - Busca o serviço a ser utilizado
-*'''UploadFile()''' - Faz o upload do arquivo no Google Drive e retorna o Id
-*'''PermitirCompartilhamentoArquivo()''' - Permite compartilhamento do arquivo para determinado endereço de email ou para qualquer um
-*'''Autenticar()''' - Autenticação da API do Google Drive