Guia de integração
Versionamento
A versão principal aparece no caminho (`/v1`). Mudanças compatíveis entram na versão existente; mudanças incompatíveis exigem uma nova versão.
Mudanças aditivas
Campos opcionais novos em respostas e campos opcionais novos em entradas podem ser introduzidos na versão atual. Clientes devem ignorar propriedades desconhecidas e tolerar novos valores apenas nos enums documentados como abertos.
Mudanças incompatíveis
Remover ou renomear campos, alterar tipos ou significados, tornar campo obrigatório ou adicionar valor a enum fechado requer nova versão principal.
Depreciação
A proposta do contrato usa os cabeçalhos Deprecation e Sunset, aviso no changelog e comunicação com 90 dias de antecedência, mantendo a versão substituída por 12 meses. Esses prazos aguardam confirmação final.
Observação: A política está descrita no contrato público. O calendário de lançamento e o canal de aviso serão publicados quando confirmados.
← Voltar ao início