🤖API Cobranças

Esta documentação tem como objetivo apresentar os endpoints disponíveis para nossos clientes. Serão abordados dois ambientes distintos: o ambiente de teste (sandbox) e o ambiente de produção. Cada um possui suas particularidades e é importante entender a diferença entre eles para o correto uso dos nossos serviços.

Antes de mergulharmos na discussão dos ambientes, é crucial entender a diferença entre um endpoint e uma API:

• Uma API (Interface de Programação de Aplicações) é um conjunto de regras e protocolos que permitem que diferentes softwares se comuniquem.
• Um endpoint, por outro lado, é um URL específico onde uma API pode ser acessada. Em outras palavras, os endpoints são os "endereços" específicos em uma API onde você pode acessar determinados dados ou funcionalidades.

💻Verbos

Os verbos de API REST são os métodos padrão utilizados para interagir com recursos em uma API RESTful. Eles descrevem a ação que está sendo realizada em um determinado recurso. Aqui estão os principais verbos e suas função.

1. GET: Ele é usado quando você quer apenas obter informações e não alterar nada no servidor. Por exemplo, ao solicitar uma lista de usuários ou detalhes de um usuário específico, você usaria o método GET.
2. POST: Ao enviar uma solicitação POST, você está enviando dados para o servidor para que ele os processe e crie um novo recurso. Por exemplo, ao enviar dados de um novo usuário para serem cadastrados no sistema.
3. PUT: Ele substitui completamente o recurso existente pelos dados fornecidos na solicitação. Por exemplo, ao atualizar as informações de um usuário, você usaria o método PUT.
4. DELETE: O método DELETE é usado para excluir um recurso do servidor. Ao enviar uma solicitação DELETE para um recurso específico, você está solicitando que o servidor remova esse recurso. Por exemplo, ao excluir um usuário do sistema.

🚩Rotas

📖Forma de Uso

Para uso da API, é necessário acessar a interface gráfica do sistema K8 Cobranças, no endereço https://sandbox.meuk8.com.br

📍Logar no sistema e gerar um acesso, na opção de menu “Acesso”:

Caso seja o primeiro acesso:

📍Clicar no botão “Gerar Credenciais de acesso”, que gera valores para os campos “Client Id”, “Client Secret” e “Chave AES”.

Se desejado, é possível especificar um IP fixo que terá permissão de uso na API, ou utilizar IP dinâmico, que é menos seguro e recomendado durante o desenvolvimento da integração com o sistema de cobranças.

Para testar interativamente a chamada de um método da API, sem a necessidade de desenvolver código, expandir o nome do método desejado:

📍Clicar no ícone no lado superior direito:

📍Informar o valor do campo “Client Id” como sendo o Username e o campo “Client Secret” como sendo o Password:

📍Marcar a checkbox “BknBankCobrancasAPI” e clicar no botão “Authorize”.
Se os dados foram informados corretamente, o ícone ser exibido em azul .

📍Agora, informar a requisição a ser enviada no campo “Request”.

Por exemplo:

{

"DataHoraInicial": 2021-02-01 T00:00:00",

"DataHoraFinal": "2021-02-26T23:59:59",

"Tipo": "Cartao",

"Estado": "Aprovado"

}

📍Informar no campo AESKey o valor do parâmetro “Chave AES”

📍Clicar no botão “Try it out!”

A resposta da chamada é exibida na janela “Response Body”.