Sobre API

Conheça agora tudo sobre a API Carteira de Cobranças.

A solução que permite você receber valores referentes a bens adquiridos, serviços prestados, produtos vendidos, contratos, tudo por meio da apresentação de boletos de pagamento emitidos pelo beneficiário(você) ao pagador/devedor(seus clientes).

O público alvo do produto são clientes do Banco Senff que contratam este serviço por meio de adicional a sua conta bancaria. O acesso ao Manager de Carteira de Cobrança possibilita o cadastro, alteração e visualização das seguintes funcionalidades:

  • Cadastro de Títulos de Cobrança
  • Visualização e Gerenciamento dos seus Sacados
  • Alteração das Instruções dos Títulos
  • Ativação das suas Credenciais de Acesso a API
  • Acesse o Swagger online da API

Vantagens

Mais Dinheiro

A utilização de boletos como forma de recebimento permite empregar esse tipo de recebível como garantia de operações de crédito

Agilidade

Com integração por API todos os eventos da Cobrança Bancária e dados trocados são em real time.

Integração

Emitir um boleto junto ao Banco Senff com integração junto a CIP.                          

Cobrança de Clientes

Realizar a consulta de vários boletos emitidos e acompanhando seus históricos.

Versatilidade

O recebimento por intermédio do boleto de cobrança é muito simples e amplamente aceito pelo público

Controle

Permite a recepção de dados instantaneamente, no ato do pagamento do boleto

Gerenciamento de Sacados

Acompanhe seus clientes de perto gerenciando seus dados mantendo-os sempre atualizados.

Boletos em PDF

Consultar boletos emitidos com a possibilitade de realizar a baixa de boletos, fazendo assim o seu cancelamento caso necessário. Alterar suas instruções para alterar vencimentos e juros por inadimplência.

Não perca tempo e começe agora!

Como usar a API Carteira de Cobranças do Banco Senff

Abaixo temos a explicação de como deve ser utilizada a API:


1) Documentação

Olá, tudo bom? Aqui vamos explicar como você irá usar a API Carteira de Cobranças. Para você que já implementou uma API REST acesse os endereços e leia a documentação:

Para você que nunca integrou uma API REST, continue lendo os tópicos seguintes que você conseguirá utilizar as funcionalidades facilmente.

1.1) O que é SWAGGER?

Para você desenvolvedor que deseja escrever uma API REST é fundamental documentar sua API, com base nesta premissa desenvolvemos a nossa utilizando SWAGGER. O Swagger é uma ferramenta que permite criar documentação para APIs e distribuir a documentação de forma otimizada, organizada, automatizada de fácil entendimento. Você pode acessar nosso swagger pelos endereços:

1.2) Como acessar a documentação do swagger?

Ao acessar o link da API Carteira de Cobranças do Banco Senff você visualizará todos os métodos disponíveis para uso e uma breve descrição:

1.2.1) Você deverá informar suas credenciais de acesso clicando no botão Authorize localizado acima do médito de login. Caso você não informar corretamente os dados de acesso sua acesso ao métodos serão negados.

1.2.2) Método de Login: Ele é o método mais importante da API, primeiro você deve solicitar a este médodo o token que credencia suas atividades de uso a API, sem ele você não irá conseguir utitlizar nenhum outro método. O token tem um prazo de vencimento e fique atento para não utilizar com ele vencido.

1.2.3) Pronto, agora com o acesso do token em mão você vai conseguir acessar todos os outros métodos da API.

O Postman é uma ferramenta que tem como objetivo testar serviços REST (Web APIs) por meio do envio de requisições HTTP e da análise do seu retorno.

Leia a licença de uso da ferramenta no site do fabricante e faça o download do Postman pelo link:

Com o POSTMAN é possível realizar as requisições conforme as especificações da API, sem termos implementado ao menos uma linha de código, desta forma, auxiliando nos testes de API’s, e para que possamos também realizar testes em nossas API’s para verificar se o comportamento dela está dentro do esperado.

Para utlizar o POSTMAN é muito simples, basta você importar o link json da documentação da nossa API dentro do POSTMAN e os métodos já ficam visiveis dentro da ferramenta, veja link e exemplo na animação abaixo:


Importe o link abaixo em seu PostMan:
Uma das vantagens desta ferramenta é testar os médotos da API e Gerar o código fonte da integração para várias linguagens de programação.

Na imagem a seguir você poderá ver como é simples testar um método da API. O Método abaixo é getToken:

Este método retorna a sua autenticação validada para o uso da API, você deverá enviar o token para todos os métodos da API, ele é um parametro obrigatório e deve ser enviado válido, cuidem sempre a validade do token.
A grande vantagem desta ferramenta é a exportação de código fontes na integração da API para várias linguagens de programação. A imagem a seguir demostra como é fácil exportar códigos fontes usando o Postman:



Acima temos exemplo de códigos gerados em c# e javascript, mas conforme a seleção do menu de opções você pode selecionar o código de sua preferencia.

API Banco Senff - Carteira de Cobranças