Leis, publicações, estatísticas, status e outros recursos públicos podem ser encontrados por identificadores estáveis.
APIs públicas
Interfaces documentadas podem ampliar transparência, verificação e reutilização sem transformar uma API em fonte de autoridade ou abrir dados que não são públicos.
O que uma API pública deve permitir
Interfaces públicas servem para consultar e verificar informação já autorizada à divulgação. Elas ampliam acesso e interoperabilidade, mas não passam a ser fonte jurídica por exibirem ou transmitirem dados.
Respostas devem permitir relacionar o dado à fonte competente, versão e momento de atualização.
Formatos e contratos documentados reduzem dependência de uma única interface ou implementação.
Contrato público de uma interface
| Dimensão | Regra pública esperada |
|---|---|
| Versionamento | Versões identificáveis, mudanças documentadas e transição previsível. |
| Disponibilidade | Metas só devem ser publicadas quando houver medição operacional verificável. |
| Limites | Limites de requisição e proteção contra abuso documentados sem discriminação arbitrária. |
| Autenticação | Consulta pública sem credencial quando o dado já for público; autenticação quando houver escopo pessoal ou restrito. |
| Privacidade | API pública não converte dado pessoal ou classificado em dado aberto. |
| Proveniência | A resposta deve apontar para a fonte institucional responsável. |
Exemplos de formato — ainda não disponíveis como serviço
Os caminhos acima são exemplos de organização. Não significam que esses endereços estejam publicados ou disponíveis hoje.
O portal possui estruturas de dados e verificação, mas a versão pública atual não apresenta uma API de Candeia em produção nem níveis de serviço mensurados.