Conheça a nossa API Reference
É bom saber
A versão antiga da documentação continua disponível aqui.
API Reference
Como gerar seu token?
Antes de iniciar as chamadas, é necessário criar uma chave de autenticação (Token), para dar continuidade ao processo de integração.
Para acessar as instruções de geração dessa chave, temos um tutorial para você: ler tutorial.
Nosso método HTTP
A API Loggi é organizada com base no REST API.
Os verbos HTTP mais comuns usados (ou métodos) são apresentados com um ícone para identificar o método da solicitação (Exemplo: GET, PUT).
Exemplos de código
Nestas documentações iremos apresentar exemplos prontos que permitirão você copiar e colar através do ícone Copy (ou copiar), para fazer solicitações às nossas APIs.
Você pode visualizar os exemplos de código na coluna à direita e pode alternar a linguagem de programação dos exemplos no topo superior direito (em Language). Fornecemos exemplos em Curl, Node, Ruby, PHP e Phyton - ou outras linguagens selecionando o botão representado pelo caractere de três pontos.
Como testar o seu endpoint?
Ao clicar no botão Try it, você poderá enviar a solicitação diretamente da página de cada API e visualizar a resposta do servidor.
O botão Try it se encontra na barra lateral direita da documentação.
Como visualizar os seus testes de endpoint?
Todos os testes de endpoint que são gerados aparecem listados na área de histórico de solicitações (You Request History). Nesse local, é possível visualizar as solicitações em até 30 dias.
Os testes realizados na página são registrados para evitar que você tenha que preencher novamente os mesmos dados ao fazer outro teste. No entanto, se a página for atualizada, esses registros não ficarão salvos.
HTTP Response
A API retorna uma mensagem (HTTP Response) em cada solicitação para indicar o sucesso ou não das solicitações da API. Os códigos listados abaixo são usados com frequência, mas a API pode usar outros. Estas respostas (4xx e 5xx) podem ser retornadas para qualquer solicitação e é possível visualizar os exemplos clicando sobre cada código na parte inferior do lado direito da página.
| Http Response Code | Code | Descrição |
|---|---|---|
| 400 - failed_preconditions | 9 | Request with invalid or incorrect data. |
| 400 - invalid_argument | 3 | Request with unselected data. |
| 401 | 16 | Access unauthorized. Check the given information. |
| 403 | 7 | Ask for authorization to access resources. |
| 404 | 5 | Request is correct, but not found on the server. |
| 429 | 8 | Too many requests in a given amount of time. |
| 500 | 13 | The server can't handle the request. |
| 503 | 14 | Request is correct, but the service is temporarily unavailable. |
Parâmetros
Em cada API, você encontrará todos os parâmetros possíveis para testar o endpoint atual. Eles estão listados abaixo do histórico de solicitações e os campos obrigatórios estão identificados como Required em vermelho.
Esses parâmetros são separados por Path Params e Body Params.
Os campos do Body Params devem ser preenchidos com a maior quantidade de informações possíveis para obter um resultado mais preciso.