API Banco do Brasil: mudanças entre as edições
Sem resumo de edição |
Sem resumo de edição |
||
| (11 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) | |||
| Linha 13: | Linha 13: | ||
[[Arquivo:Tela do aplicativo.png|centro|Tela de dados do aplicativo]] | [[Arquivo:Tela do aplicativo.png|centro|Tela de dados do aplicativo]] | ||
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 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). | |||
[[Arquivo:Cadastro nova aplicação.png|centro|Cadastro nova aplicação]] | |||
Logo abaixo você deve selecionar quais APIs o seu aplicativo ira obter, os aplicativos podem possuir APIs de cobranças ou pagamentos. | |||
[[Arquivo:Apis para aplicação Cobrança.png|centro|Apis para aplicação cobrança]] | |||
[[Arquivo:Apis para aplicação pagamento.png|centro|Apis para aplicação pagamento]] | |||
Com o aplicativo selecionado basta ir na barra de menus no canto esquerdo. | |||
[[Arquivo:Barra de menus BB.png|centro|Barra de menus do aplicativo BB]] | [[Arquivo:Barra de menus BB.png|centro|Barra de menus do aplicativo BB]] | ||
Para obter as credenciais para poder realizar os testes ou até mesmo as credencias de produção, basta clicar em credenciais. | Para obter as credenciais para poder realizar os testes ou até mesmo as credencias de produção, basta clicar em credenciais. | ||
[[Arquivo:Credenciais de teste dados ocultos.png|centro|Credenciais de teste dados ocultos]] | |||
== 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). | |||
[[Arquivo:Dashbord toolstrip BB.png|centro|Dashboard]] | |||
[[Arquivo: | 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:Barra lateral documentação.png|centro|Homologação e teste]] | |||
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:Dados ficticios documentação.png|centro|Dados ficticios documentação]] | |||
[[Arquivo:Dados ficticios requisicao.png|centro|Dados ficticios requisicao]] | |||
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:Barra Lateral SandBox.png|centro|Barra Lateral SandBox]] | |||
Ao clicar em "Cobrança" por exemplo, a tela abaixo será exibida: | |||
[[Arquivo:Ambiente de teste api bb.png|centro]] | |||
Porém, antes de utilizar a API você precisa Autorizar as suas credenciais, basta clicar em "Authorize": | |||
[[Arquivo:Tela de autorização sandbox.png|centro|Tela de autorização SanxBox]] | |||
== | 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. | Para colocar a aplicação em Produção basta ir na barra de menus no canto esquerdo e clicar em Produção. | ||
[[Arquivo:Produção.png|centro|Colocando o aplicativo BB em produção]] | [[Arquivo:Produção.png|centro|Colocando o aplicativo BB em produção]] | ||
Ao clicar a tela de inicio para colocar o aplicativo em produção será exibida. | Ao clicar a tela de inicio para colocar o aplicativo em produção será exibida, basta seguir os passos. | ||
[[Arquivo:Inicio da produção.png|centro|Inicio da produção para o aplicativo BB]] | [[Arquivo:Inicio da produção.png|centro|Inicio da produção para o aplicativo BB]] | ||
== 6° Passo - Configurar WebHook ERP == | |||
Para o funcionamento do webhook é necessário algumas informações no ERP: | |||
[[Arquivo:Parametros webhook Conta.png|centro]] | |||
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: | |||
[[Arquivo:Parametros webhook banco.png|centro]] | |||
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:Informações banco de dados xml de configurações webservice.png|centro]] | |||
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: | |||
[[Arquivo:Arquivo webconfig parametrização valores.png|centro]] | |||
== 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: | |||
[[Arquivo:Menu lateral aplicativo bb.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. | |||
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 | |||
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