Developers / Começando
Começando

Versionamento

A API é versionada por prefixo de URL (/v1/...). Mudanças que quebram compatibilidade nunca acontecem dentro de uma versão já publicada.

O que conta como mudança compatível (não quebra nada)

  • Adicionar um campo novo e opcional numa resposta.
  • Adicionar um endpoint novo.
  • Adicionar um valor novo a um enum existente (ex.: um status novo de webhook).

O que gera uma versão nova (/v2/...)

  • Remover ou renomear um campo existente.
  • Mudar o tipo de um campo (ex.: string vira número).
  • Tornar obrigatório um campo que antes era opcional.
💡
Novidades e mudanças (sempre compatíveis dentro da mesma versão) ficam registradas em Changelog.