​
Bem-vindo à API Reference

A API do Sollos Consultas permite executar consultas de dados cadastrais, financeiros e jurídicos de forma programática. Toda a comunicação é feita via HTTP REST com respostas em application/json.

Comece pelo Login

Obtenha seu token JWT para autenticar as requisições

Execute uma Consulta

Entenda o modelo assíncrono de execução

Veja o Resultado

Acompanhe o andamento e obtenha a resposta

Monitore o Consumo

Estatísticas de uso por período

​
Base URL

https://api.sollosconsultas.com.br

​
Autenticação

Todas as rotas (exceto POST /auth/login) exigem o header abaixo: 
x-access-token: <seu_token_jwt>
O token é obtido via POST /auth/login. Sem ele, qualquer requisição retorna 401 Unauthorized.
Trate o token como uma senha. Não o exponha em repositórios públicos, variáveis de ambiente versionadas ou código client-side. Em ambientes de produção, armazene-o de forma segura (ex: secrets manager, variável de ambiente no servidor).

​
Códigos de status

CódigoSignificado
200 OKRequisição processada com sucesso
202 AcceptedConsulta aceita para processamento (resultado ainda pendente)
400 Bad RequestParâmetros ausentes ou inválidos na requisição
401 UnauthorizedToken ausente, inválido ou expirado
403 ForbiddenSem permissão para este recurso ou limite de uso atingido
404 Not FoundRecurso não encontrado
500 Internal Server ErrorErro interno ou falha no provedor externo

​
Modelo assíncrono de execução

As consultas não retornam o resultado imediatamente. O fluxo funciona assim:
1

Executar

Envie POST /consultas/executar/{id} com os parâmetros da consulta. A API retorna imediatamente um consultaId com status 202.
2

Aguardar

O provedor externo processa a consulta em segundo plano. A maioria das consultas conclui em 1 a 3 segundos.
3

Verificar

Faça GET /consultas/resultado/{consultaId}. Se status for pending, aguarde 2 segundos e tente novamente.
4

Resultado pronto

Quando status for completed, o campo resultados contém a resposta completa do provedor. Guarde o query_execution para recuperar o resultado futuramente.
Implemente um backoff simples: tente a cada 2 segundos por até 15 tentativas. Se ainda estiver pending após isso, tente novamente em alguns minutos — a consulta pode estar em um pico de fila.

​
Formato de erro

Todos os erros seguem o mesmo formato: 
{
  "message": "Descrição do que deu errado."
}