Changelog da API e das docs
Toda mudança na API, na documentação e na base de dados, com data. Mudanças incompatíveis são anunciadas aqui antes de valer.
Este registro lista o que mudou na API /v1 (contrato, códigos de erro, campos), nas docs e na base de dados (cada nova foto mensal), da mudança mais recente para a mais antiga. A versão vigente do contrato é 1.0.0; a política de mudanças está em Versionamento.
Registro
· api · versão 1.0.0
Novo código de erro: account_suspended
Conta suspensa pelo suporte, por motivo que não é pagamento, responde `403 account_suspended` em toda chamada com chave, antes de `payment_required`, sem custo. Mudança aditiva: a versão não muda.
· api · versão 1.0.0
Busca com filtros por plano, listas e filter_not_in_plan
`GET /v1/cnpjs` ganha filtros de nome, contatos, regime, CNAE secundário, matriz ou filial, filiais, data, motivo e situação especial, exclusão de municípios, CEP e bairro, sócio, raio, faturamento e funcionários; os parâmetros de código aceitam lista por vírgula; cada filtro tem um plano mínimo, e filtro acima do plano responde `403 filter_not_in_plan`, sem custo. Mudança aditiva: a versão não muda.
· api · versão 1.0.0
Contrato 1.0.0: fim do sufixo draft
O contrato sai de `1.0.0-draft.4` para `1.0.0` sem mudança de forma — é o mesmo documento gerado pela implementação. A partir daqui vale a política de versionamento: mudança aditiva não muda a versão do path; mudança incompatível cria `/v2` com convivência de 90 dias. A API já se declarava `1.0.0` em `GET /v1/status`.
· api · versão 1.0.0-draft.4
Contrato alinhado à correção da API de 13/09
Os dois pontos anunciados na entrada de 12/09 entraram na API: `GET /v1/usage` não responde mais `503` na manutenção (só as operações cobradas), e `data_as_of` de `GET /v1/status` passa a admitir `null` antes da primeira carga. Zero diferenças estruturais entre este contrato e o gerado pela implementação (`bin/cnpjia_openapi_diff`).
· docs · versão 1.0.0-draft.4
Docs alinhadas ao contrato gerado
Consulta, busca, campos, créditos e limites, erros e retentativas, dados e frescor, privacidade e versionamento seguem o draft.4: CPF mascarado, faixa de funcionários por modelo estatístico, escriturações sempre vazias na v1.0, tabela de erros por operação derivada dos exemplos do contrato, headers por resposta e descoberta.
· api · versão 1.0.0-draft.4
Contrato 1.0.0-draft.4, gerado pela implementação
Quatro caminhos de descoberta no host da API (`/openapi.json`, `/robots.txt`, `/llms.txt`, `/.well-known/api-catalog`); CPF de sócio e de representante mascarado em `cnpj_cpf_socio` e `cpf_repres`; `codigo` nulável; header `X-Client-Request-Id` e headers declarados resposta por resposta; `500` em todas as operações e `404`, `503` e `504` onde ocorrem; `explicacao` ignorado na busca; `descricao` não vazia no gerador. Dois pontos descrevem o comportamento atual e mudam na próxima correção da API: `GET /v1/usage` deixa de responder `503` na manutenção e o tempo limite da busca passa de `500` a `504`.
· docs · versão 1.0.0-draft.3
Publicação da documentação
Índice, início rápido, autenticação, consulta, busca, campos, créditos e limites, erros, MCP, CNPJ alfanumérico, dados e frescor, privacidade e uso aceitável, changelog e versionamento.
Como acompanhar
GET /v1/status informa api_version e data_as_of sem chave; nas respostas de consulta e busca, a data da base está em meta.data_as_of. Assinantes recebem por e-mail o aviso de qualquer mudança incompatível com antecedência.