Skip to main content

Integração via API REST

Integre diretamente com a API REST do Sherlocker usando qualquer linguagem ou ferramenta HTTP. Nenhuma biblioteca adicional é necessária.

Base URL

Autenticação via Bearer token — veja Autenticação para detalhes.

Primeira requisição

cURL

Python

Node.js

PHP

Padrão de resposta

As respostas são objetos JSON diretos — sem wrapper success/results. Cada endpoint retorna os dados no formato do recurso consultado. Exemplo para /pessoas/cpf/{cpf}:
Em caso de erro, a resposta segue o formato:

Erros

Consultas paralelas

Para melhor performance, execute consultas independentes em paralelo:

Python (asyncio)

Node.js (Promise.all)

Endpoints async

Módulos demorados (processos, perfis, bancos, cadastros) oferecem modo async:

Polling em Python

Rate limits

Ao atingir o limite, a API retorna 429 Too Many Requests. Implemente backoff exponencial: