Particularidades de Configuração da API
Banco Safra
Para melhor visualização das imagens, clique sobre elas.
Para realizar as configurações relevantes ao uso da API de Cobrança (Emissão Direta – v3.0) pelo BankPlus, siga o guia detalhado:
1º O próprio cliente deve entrar em contato com o banco para a contratação da API.
2º Após a contratação da API, é responsabilidade da consultoria e do cliente, junto ao banco, realizar a homologação, a liberação das credenciais de acesso (OAuth 2.0) e as configurações no contrato bancário. Para saber mais informações sobre a configuração do contrato, siga a documentação.
Para utilizar o registro de cobrança via API, basta habilitar a flag:
As versões API disponíveis para o Banco Safra são essas a seguir. Selecione a versão que deseja.
A versão a ser selecionada corresponde à API de Cobrança do Safra – Emissão Direta (v3.0).
Em Tipo de Ambiente selecione o cenário onde as operações serão realizadas; em produção são operações reais.
No ambiente de Teste (homologação), a URL dos serviços utiliza o sufixo -hml. Em Produção, é utilizada a URL oficial, sem o sufixo -hml.
Após selecionar a versão da API e o tipo de ambiente, aparecerão os demais campos para configuração:
As informações de acesso (Client ID, Usuário e Senha) serão fornecidas pelo próprio banco após a finalização da contratação desse serviço, ressaltando que essas informações são únicas para cada cliente.
Após adicionar as credenciais, clique em Atualizar:
Validação / Homologação
Para o processo de homologação é necessário realizar a validação do JSON de envio. Para isso, acesse BankPlus → Cobrança → Títulos Bancários. Após realizar o Registro Online via API, selecione o título e clique em Histórico:
Arraste a barra de rolagem para encontrar a coluna que grava a informação referente ao envio do JSON de comunicação.
Operações disponíveis via API
A integração com a API de Cobrança do Safra (Emissão Direta – v3.0) contempla as seguintes operações realizadas diretamente pelo BankPlus:
- Registro do título (emissão do boleto);
- Consulta do título;
- Alteração de vencimento;
- Baixa / Cancelamento do título.
Em caso de rejeição no registro ou nas demais operações, consulte a coluna JSON retornado na API no Histórico do boleto: ela traz a mensagem de retorno do banco, que auxilia na identificação do motivo.