Esta documentação descreve todos os métodos de API para as seguintes ações:
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.
Todas as solicitações de API são feitas usando os seguintes métodos HTTP:
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.
Cada solicitação de API deve sempre conter 4 variáveis:
Se a solicitação for bem-sucedida, a API sempre retornará duas variáveis:
Se a solicitação falhar, a API mostra as variáveis:
Cada solicitação de API deve conter uma variável de hash que é a assinatura digital da solicitação.
hash = md5($json . $time . $salt)