Introdução

HTTP

Nossa API utiliza códigos de resposta convencionais de HTTP para indicar o sucesso ou a falha de uma requisição. Sendo assim, códigos 2xx indicam sucesso, 4xx indicam erros por algum dado informado incorretamente (por exemplo, algum campo obrigatório não enviado) e códigos 5xx indicando erros em nossos servidores.

Caso o retorno de erro 500 persista por um período considerável, entre em contato com nosso suporte.

URLs de integração

Contexto
Endpoint

Requisição base

Todas as requisições de autenticação e solicitação de relatórios, devem ser requisitados através do método POST.

Alguns retornos de relatórios que forem do tipo de processamento assíncrono, deverão ser requisitados através do método GET conforme instruções adiante.

Headers

Todas as requisições são transacionadas em JSON, por isso devem obrigatoriamente possuir os headers a seguir para uma conexão bem sucedida:

Header
Valor

Accept

application/json

Content-Type

application/json

Authorization

Bearer ACCESS_TOKEN

Last updated