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

Edição das 15h55min de 23 de agosto de 2023

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.

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". 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 - Tela consentimento OAuth

5° Passo - Publicar Projeto

6° Passo - Biblioteca de APIs

7° Passo - Configurar credenciais

8° 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.

10° 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

10° Principais Métodos

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

@@ 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.
-== 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". Com o aplicativo selecionado basta ir na barra de menus no canto esquerdo.
-[[Arquivo:2 - criarprojeto.png|centro]]
-Nomear o projeto com o nome de preferência
+[[Arquivo:Barra de menus BB.png|centro|Barra de menus do aplicativo BB]]
-[[Arquivo:3 - nomeprojeto.png|centro]]
-== 4° Passo - Tela consentimento OAuth ==
+Para obter as credenciais para poder realizar os testes ou até mesmo as credencias de produção, basta clicar em credenciais.
-Ir para APIS & Serviços - Tela de Consentimento OAuth
-[[Arquivo:4 - oauth.png|centro|oauth]]
+[[Arquivo:Credenciais de teste.png|centro|Credencias de teste do BB]]
-Escolha o projeto que será feito a autorização do OAuth
+== 4° Passo - Tela consentimento OAuth ==
-[[Arquivo:5 - projoauth.png|centro]]
-Com o projeto selecionado, configurar o tipo para externo
-[[Arquivo:6 - configoauth1.png|centro]]
-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
-[[Arquivo:7 - configoauth2.png|centro]]
-Logo abaixo, é preciso definir o email do desenvolvedor ou responsável pela implantação do projeto e prosseguir
-[[Arquivo:8 - configoauth3.png|centro]]
-Em escopos clique em "Adicionar ou remover escopos"
-[[Arquivo:Adicionar escopos.png|centro]]
-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:Adicionar escopo tabela.png|centro]]
-Com o escopo adiciona a tabela você pode visualizar que um valor nos filtros está marcado:
-[[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:Escopos não confidenciais.png|centro]]
-Depois disso basta salvar e continuar até o "Resumo" e voltar ao painel inicial
 == 5° Passo - Publicar Projeto ==
-Com o consentimento configurado basta publicar o projeto:
-[[Arquivo:Publicar projeto.png|centro]]
-'''Importante:
-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==
-Após baixar o arquivo, clicar em Biblioteca
-[[Arquivo:16 - library.png|centro]]
-Pesquisar por "Google Drive" e ativar a API
-[[Arquivo:Api google drive.png|centro]]
-Pesquisar por Google+
-[[Arquivo:17 - libraryapi.png|centro]]
-Selecionar Google+ API
-[[Arquivo:18 - googole+.png|centro]]
 == 7° Passo - Configurar credenciais ==
-Com o autorização do OAuth concluída e com o projeto publicado, ir em Credenciais - Criar Credenciais
-[[Arquivo:10 - configcredenciais.png|centro]]
-Clicar em Cliente Id OAuth
-[[Arquivo:11 - keyoauth.png|centro]]
-Definir o tipo de aplicação como "Para Computador", definir um nome e Criar
-[[Arquivo:13_-_configketoauthnome.png|centro]]
-Credenciais criadas do OAuth, basta clicar em "Download JSON"
-[[Arquivo:14 - keysoauth.png|centro]]
-Um arquivo Json com as credenciais será baixado na máquina
-[[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
-== 8° Passo - Configurar no ERP ==
-Para configurar no ERP, é preciso ir em Configurações -> Configurações de Integração
-[[Arquivo:21 - erp-config.png|centro]]
-Ir até a aba Google Drive
-[[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.
+== 8° Passo - Produção ==
-[[Arquivo:23 - acessoautorizadoapi.png|centro]]
+Para colocar a aplicação em Produção basta ir na barra de menus no canto esquerdo e clicar em Produção.
-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"
+[[Arquivo:Produção.png|centro|Colocando o aplicativo BB em produção]]
-[[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
+Ao clicar a tela de inicio para colocar o aplicativo em produção será exibida.
-[[Arquivo:25 - msgerro.png|centro]]
+[[Arquivo:Inicio da produção.png|centro|Inicio da produção para o aplicativo BB]]
-== 8° Como testar a classe ==
+== 10° 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
-== 9° Principais Métodos ==
+== 10° Principais Métodos ==
 *'''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