Documentação da API

Consulta processual multi-tribunal

Serviço de integração com tribunais (hoje: TJ-MT). Todas as rotas em /api/v1/ exigem autenticação por chave. Esta página é pública para leitura.

Base URL

Em produção, use o host configurado no Traefik (ex.: https://crawler.unithub.com.br). Os exemplos abaixo usam / como caminho relativo à origem atual.

Autenticação

Defina API_KEY no servidor. Em cada requisição à API, envie um dos seguintes:

Requisições OPTIONS (preflight CORS) não exigem chave. A documentação em HTML e o arquivo OpenAPI em /openapi.yaml são públicos.

Endpoints

GET /api/v1/tribunais

Lista tribunais suportados (codigo, nome, implementado). 

curl -sS -H "X-API-Key: SUA_API_KEY" "ORIGEM/api/v1/tribunais"
GET /api/v1/consulta

Parâmetros de query obrigatórios: tribunal (ex. tjmt), numeroUnico (CNJ com ou sem máscara). Opcional: exibirArquivados ou arquivados (true/false, sim/nao, etc.). 

curl -sS -H "X-API-Key: SUA_API_KEY" \
  "ORIGEM/api/v1/consulta?tribunal=tjmt&numeroUnico=1011293-58.2019.8.11.0015&exibirArquivados=true"
POST /api/v1/consulta

Corpo JSON com tribunal (ou tribunalCodigo, court), número do processo (numeroUnico, numero, cnj…) e opcionalmente exibirArquivados. 

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"tribunal":"tjmt","numeroUnico":"1011293-58.2019.8.11.0015","exibirArquivados":true}' \
  "ORIGEM/api/v1/consulta"
GET /openapi.yaml

Especificação OpenAPI 3 (pública). Importe no Postman, Insomnia ou gere cliente.

GET /health

Health check (ok). Público para balanceadores e probes.

Resposta

JSON com tribunal, tribunalNome, encontrado, movimentações quando aplicável, etc. Em caso de processo não encontrado, encontrado: false e numeroConsulta.

Referência

Especificação OpenAPI (/openapi.yaml)