DOCUMENTAÇÃO

API CPX

 ← Voltar ao Código Penal

API DE CONSULTA • V1

Integração com outros projetos

A API externa é somente leitura e usa uma chave própria. A planilha e as credenciais do Google continuam restritas ao servidor.

Autenticação

Envie a chave no header Authorization: Bearer SUA_CHAVE ou X-API-Key: SUA_CHAVE.

curl -H "Authorization: Bearer SUA_CHAVE" \
  "/api/v1/crimes?q=homicidio"

Para aplicações web, não coloque a chave secreta diretamente no JavaScript do navegador. O ideal é consultar esta API pelo backend do outro projeto.

GET

/api/v1/crimes

Lista e pesquisa crimes.

?q=roubo&sort=fine&order=desc&limit=20&offset=0
GET

/api/v1/crimes/lookup

Busca exata pelo nome.

?crime=Homicídio
GET

/api/v1/meta

Quantidade de registros, versão, fonte e última sincronização.

Parâmetros de ordenação

sort=crime, sort=prison ou sort=fine. Use order=asc ou order=desc.

GET /api/v1/crimes?sort=prison&order=desc
GET /api/v1/crimes?q=5000
GET /api/v1/crimes/lookup?crime=Tráfico%20de%20Drogas