Conheça a nossa API Reference

19211921

ūüöß

√Č bom saber

A versão antiga da documentação continua disponível aqui.

API Reference

A integração com a Loggi requer três etapas:
  1. Crie o seu token para que a Loggi possa autenticar suas solicita√ß√Ķes de API de integra√ß√£o, mas para isso ser√° necess√°rio obter suas credenciais com a Loggi por meio do email [email protected]

  2. Navegue pela nossa documentação referente a cada API pelo menu lateral esquerdo.

  3. Teste as APIs seguindo as instru√ß√Ķes encontradas em cada documenta√ß√£o.



Como se autenticar para utilizar as APIs da Loggi?

Antes de utilizar as nossas APIs voc√™ precisa fornecer alguns dados de autentica√ß√£o. Para ter acesso a esses dados, entre em contato com a Loggi por meio do e-mail [email protected].

Essas credenciais s√£o:

  • client_id
  • client_secret

Elas funcionam juntas como um par de ID e senha e s√£o fornecidos pela Loggi.
Logo no in√≠cio da p√°gina de cada API, voc√™ encontrar√° as instru√ß√Ķes necess√°rias para criar um Token tempor√°rio a partir dessas credenciais. Isso permitir√° o acesso √†s APIs p√ļblicas deste servi√ßo.

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.

19211921

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.

19221922

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.