OpenAPI 3.0
Referência pública para integradores: catálogo de ferramentas, Consultas Brasil, execução versionada (/v1/services/…/execute), jobs assíncronos e FIPE. Rotas de consulta e engines retornam o envelope estável abaixo; catálogo e jobs têm formatos próprios (detalhados na spec).
Consultas (/queries/*), execute v1 e FIPE:
{
"ok": true,
"data": { "cep": "01310100", "localidade": "São Paulo", "uf": "SP" },
"error": null,
"meta": {
"serviceKey": "query.cep",
"source": "ViaCEP",
"fetched_at": "2026-07-30T22:00:00.000Z",
"cached": false,
"latency_ms": 142
}
}Base da API: https://api.praca.id. Consultas, execute v1 e FIPE usam o envelope { ok, data, error, meta }.
curl -sS "https://api.praca.id/api/portal-tools/queries/cep?cep=01310100"Resposta: { "ok": true, "data": { ... }, "error": null, "meta": { "source": "ViaCEP", ... } }
curl -sS -X POST "https://api.praca.id/api/portal-tools/v1/services/calc.porcentagem/execute" \
-H "Content-Type: application/json" \
-d '{"input":{"valor":200,"percentual":15}}'Header opcional: -H "X-Api-Key: sua-chave"
curl -sS -X POST "https://api.praca.id/api/portal-tools/v1/services/query.cep/execute" \
-H "Content-Type: application/json" \
-d '{"input":{"cep":"01310100"}}'curl -sS "https://api.praca.id/api/fipe/consulta/001004-9/1998?combustivel=Gasolina"A consulta salva a variante e sua série histórica; meta informa fonte, cache e disclaimer.
curl -sS -X POST "https://api.praca.id/api/portal-tools/jobs" \
-H "Content-Type: application/json" \
-d '{"service_key":"job.echo","payload_meta":{"text":"Olá, Praça!"}}'Jobs retornam recurso { id, status, result_meta, ... } — não usam envelope ok/data.
curl -sS "https://api.praca.id/api/portal-tools/jobs/{uuid-do-job}"curl -sS "https://api.praca.id/api/portal-tools/tools?featured=true&limit=10"Catálogo retorna JSON direto (array), sem envelope.
Especificação completa: praca-api.yaml. Termos: /api-termos.
Renderizado com Redoc (estático). Alinhado aos controllers Nest em portal-tools e fipe.
Carregando documentação interativa…