Transparência

API pública v1

Acesso aberto, somente leitura, apenas sobre conteúdo efetivamente publicado. Não há dados pessoais, caminhos de arquivo, credenciais ou identificadores internos. Não é necessária autenticação.

GET /api/public/v1/outorgas

Lista as outorgas efetivamente publicadas, da mais recente para a mais antiga.

Parâmetros: page (1+), page_size (1–100, padrão 20), q (busca por título), identificador (igualdade exata), formato (json padrão, csv ou pdf)

/api/public/v1/outorgas?page=1&page_size=20&q=abastecimento

GET /api/public/v1/modulos

Catálogo público de módulos da plataforma (somente módulos com visibilidade pública).

Parâmetros: formato (json padrão, csv ou pdf)

/api/public/v1/modulos?formato=csv

GET /api/public/v1/datasets

Catálogo dos conjuntos de dados abertos, com endpoint e formatos disponíveis.

Parâmetros: —

/api/public/v1/datasets

GET /api/public/v1/outorgas/{identificador_publico}

Detalhe público de uma outorga publicada, com metas, investimentos e documentos públicos.

Parâmetros: identificador público (slug) ou identificador do processo

/api/public/v1/outorgas/compesa-2026-hom-0001-ab12cd

GET /api/public/v1/investimentos

Investimentos públicos das outorgas publicadas.

Parâmetros: page, page_size, outorga (identificador público)

/api/public/v1/investimentos?outorga=compesa-2026-hom-0001-ab12cd

GET /api/public/v1/documentos

Metadados dos documentos classificados como públicos nas outorgas publicadas.

Parâmetros: page, page_size, outorga (identificador público)

/api/public/v1/documentos?page=1&page_size=20

GET /api/public/v1/verificar/{codigo}

Verificação de autenticidade de uma publicação a partir do código impresso no comprovante.

Parâmetros: código de verificação (8 a 64 caracteres)

/api/public/v1/verificar/ABCDEF-123456-GHIJ

GET /api/public/v1/openapi

Especificação OpenAPI 3.0 desta API.

Parâmetros: —

/api/public/v1/openapi

Formato das respostas

Listagens retornam { data, pagination { page, page_size, total }, last_updated_at }. Detalhes retornam { data }. Erros retornam { error { code, message } } com o código HTTP correspondente: 400 (parâmetro inválido), 404 (não encontrado ou não publicado), 429 (limite de requisições), 500 (falha ao consultar).

Limite de requisições

60 requisições por minuto por endereço de origem. Cada resposta traz os cabeçalhos x-ratelimit-limit, x-ratelimit-remaining e x-ratelimit-reset. Respostas são cacheáveis por 60 segundos.

Escopo

Só aparecem outorgas com publicação concluída e documentos classificados como públicos. Conteúdos ainda não definidos como públicos — por exemplo, detalhamento de contratos e empenhos — não são expostos.

Verificar autenticidade de um documento publicado