Mudanças incompatíveis

Mudanças que possam quebrar uma integração existente recebem comunicação destacada e antecedência.

O que conta como incompatível

• remoção de campo;
• mudança de tipo de um campo;
• alteração ou remoção de valor de enum;
• remoção de endpoint;
• mudança de autenticação;
• mudança obrigatória de fluxo.

O que cada aviso informa

1. o que muda;
2. por que muda;
3. quem é afetado;
4. data de entrada em vigor;
5. como migrar;
6. exemplo antigo e novo.

Nenhuma até aqui

Não há mudança incompatível registrada. Quando houver, ela aparece aqui antes de entrar em vigor.

O compromisso com os nomes existentes

Vale um exemplo do que essa política significa na prática. Quando a marca mudou para Conota, os headers de webhook não foram renomeados — continuam X-Qualyfiscal-Signature, X-Qualyfiscal-Job-Id, X-Qualyfiscal-Tentativa. Eles são contrato, não marca: renomear quebraria a validação de assinatura de toda integração existente, e a falha apareceria do lado do cliente, silenciosamente. O mesmo vale para os domínios antigos api.pluganota.com e api.qualyfiscal.com.br, que seguem ativos.