API Banco do Brasil

De Base de Conhecimentos da DataPlus Sistemas
Revisão de 15h27min de 23 de agosto de 2023 por Vinicius (discussão | contribs) (Criou página com '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 == Criar uma co...')
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)
Ir para navegação Ir para pesquisar

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

Criar uma conta no Gmail, ou utilizar a existente

Acessar o link: https://console.cloud.google.com/getting-started

3° Passo - Criar um projeto

Clicar em Select Project - Para criar um projeto e depois em New Project

Nomear o projeto com o nome de preferência

4° Passo - Tela consentimento OAuth

Ir para APIS & Serviços - Tela de Consentimento OAuth

oauth
oauth

Escolha o projeto que será feito a autorização do OAuth

Com o projeto selecionado, configurar o tipo para externo

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

Logo abaixo, é preciso definir o email do desenvolvedor ou responsável pela implantação do projeto e prosseguir

Em escopos clique em "Adicionar ou remover escopos"

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"

Com o escopo adiciona a tabela você pode visualizar que um valor nos filtros está marcado:

Depois disso basta clicar em atualizar e as informações do "Escopos não confidenciais vai ser atualizada":

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:

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

Pesquisar por "Google Drive" e ativar a API

Pesquisar por Google+

Selecionar Google+ API

7° Passo - Configurar credenciais

Com o autorização do OAuth concluída e com o projeto publicado, ir em Credenciais - Criar Credenciais

Clicar em Cliente Id OAuth

Definir o tipo de aplicação como "Para Computador", definir um nome e Criar

Credenciais criadas do OAuth, basta clicar em "Download JSON"

Um arquivo Json com as credenciais será baixado na máquina

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

Ir até a aba Google Drive

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.

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"

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

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

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