Voltar ao site
Conceitos

Versionamento e changelog

Versão na URL, mudanças compatíveis na v1 e quebra de contrato só em /v2.

Página em construção

Este é um resumo. O conteúdo completo entra nas próximas versões da documentação; o contrato de cada rota já está na Referência da API.

  • A versão vai na URL: /v1. Mudança que quebra contrato sai numa versão nova (/v2).
  • Na v1 podem entrar, sem aviso prévio, campos novos na resposta, valores novos em enums e eventos novos. Seu código deve ignorar o que não conhece.
  • Os eventos de webhook trazem apiVersion (ex.: 2026-10-01).
  • Cada mudança é registrada no Changelog.