pt
Fintech

Documentação da API

O site do cliente, back office e todos os módulos da plataforma trabalham com arquivos de banco de dados por meio da API, e não diretamente. A API controla o acesso, integridade e exatidão dos dados recebidos.

Descrição geral

Como funciona a API?

API - o nó chave da plataforma

Esta documentação descreve todos os métodos de API para as seguintes ações:

  • obtendo listas de objetos (método list)
  • filtragem de lista (método de lista com dados de filtro)
  • obter informações detalhadas sobre um objeto (método show)
  • obtendo dados para o formulário add object (método add)
  • salvando dados como um novo objeto (método store)
  • obtendo dados para o formulário de atualização do objeto (método de edição)
  • salvando os dados do objeto atualizado (método de atualização)

Verificando por endereço IP

A API só aceita solicitações de uma lista limitada de endereços IP (por exemplo, do site da conta de um cliente ou de um site de back office).

Qualquer solicitação à API de um endereço IP que não esteja na lista de permissões será rejeitada.

Isso é feito para evitar ataques DDoS na API, tentativas de falsificar solicitações e experimentos de hackers.

Os usuários sempre acessam o site público da plataforma (escritório do cliente ou back office), e este próprio site solicita os dados necessários da API da plataforma. Como o endereço IP do site é fixo, ele estará na lista de permitidos.

URL e método

Todas as solicitações de API são feitas usando os seguintes métodos HTTP:

  • GET para listar, mostrar, adicionar e editar
  • POST para loja
  • PUT para atualização
  • DELETE para excluir

Cada seção da API contém uma URL para a qual é feita uma solicitação para obter os dados relevantes.

O método de solicitação HTTP é especificado na frente de cada URL.

Enviando uma solicitação

Cada solicitação de API deve sempre conter 4 variáveis:

  1. data (string json com matriz de dados para API)
  2. user (string json com uma matriz de dados sobre o usuário atual)
  3. time (hora atual no fuso horário UTC)
  4. hash (assinatura digital na forma de hash para verificar se a solicitação à API é definitivamente de uma fonte autorizada)

Obtendo resposta da API

Se a solicitação for bem-sucedida, a API sempre retornará duas variáveis:

  1. status = true (estado de sucesso)
  2. data (string json com matriz de dados da API)

Se a solicitação falhar, a API mostra as variáveis:

  1. status = false (estado de erro)
  2. error (string de texto descrevendo o erro)

Assinatura digital

Cada solicitação de API deve conter uma variável de hash que é a assinatura digital da solicitação.

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — algoritmos de criptografia disponíveis
  • $json — string json com dados de solicitação
  • $time — hora no formato "DD.MM.AAAA HH:MM:SS"
  • $salt — valor único fixo ("sal") para a API da plataforma

Fintech

A documentação contém exemplos de solicitações de API reais