API pública e tokens de acesso

Como outro sistema consulta as vistorias do seu negócio por uma interface autenticada por token.

A API pública existe para que um sistema do seu negócio, um ERP ou um portal do cliente consulte as vistorias sem que alguém precise copiar dados na mão.

Autenticação por token

O acesso é feito com um token do próprio negócio, enviado como credencial na requisição. O contexto da empresa vem do token, e não de um cabeçalho que o chamador escolhe: por construção, um token não alcança dados de outro negócio.

O token tem escopo. Um token de leitura de vistorias lê vistorias e nada além disso.

O que a versão atual expõe

A consulta da lista de vistorias do negócio.
A consulta de uma vistoria específica.

A documentação técnica dos endpoints está publicada em formato OpenAPI, no endereço de documentação da API, e é a referência para quem for integrar.

Limite de requisições

As chamadas são limitadas por período. Uma integração que consulta em laço apertado será barrada; consulte com intervalo e trate a resposta de limite excedido.

Guarde o token como senha

Requisito de plano

A API é um recurso de plano. Sem ele, a criação de tokens é recusada.

Como obter

A criação de tokens é feita por quem administra as configurações do negócio. Se você não encontra a opção, confira o plano contratado e fale com o suporte.