Versionamento

A API Auvo adota versionamento de URL: a v2 vive em /v2. Mudanças compatíveis (adição de campos opcionais, novos endpoints) entram em v2; mudanças incompatíveis vão para a próxima major.

• Um endpoint ou campo marcado como deprecado permanece por no mínimo 90 dias.
• Deprecações aparecem:
  • Em x-deprecation-date no spec.
  • Na resposta, via cabeçalho Deprecation: @timestamp.
  • No changelog semanal.
  • Em e-mail para administradores das contas que usaram o endpoint nos últimos 30 dias.

• Novos campos opcionais em requests.
• Novos campos em responses.
• Novos endpoints / novos verbos.
• Novos códigos 2xx e 4xx com significado adicional.

• Remover/renomear campos ou endpoints.
• Mudar tipos/enums existentes.
• Adicionar campos obrigatórios em requests.
• Mudar códigos HTTP para operações já existentes.

Inscreva-se em changelog.rss ou siga nosso RSS/Atom feed. Assinantes de Webhooks com eventos api.deprecated também recebem notificação.