Pular para o conteúdo
API e webhooksv1
openapi.yaml
Menu da APIVersionamento

Versionamento

A versão maior vai no caminho: https://api.precificador3d.com.br/v1.

Entra na v1 sem aviso

  • Campo novo numa resposta.
  • Evento de webhook novo e campo novo em dados.
  • Valor novo num campo de lista aberta (como status).
  • Operação nova.

Por isso, o seu código precisa ignorar o que não conhece: não quebre com campo novo e trate valor desconhecido com um caminho padrão.

Só numa versão nova

Tirar ou renomear campo, mudar tipo ou mudar o sentido de algo só acontece em /v2, e a /v1 continua funcionando por 12 meses depois que a /v2 sair.

Como a API avisa

  • Cabeçalhos Deprecation e Sunset nas respostas do que vai sair, com Link para esta documentação.
  • E-mail ao dono das chaves que usaram o recurso nos últimos 30 dias, 6 meses, 1 mês e 1 semana antes.
  • Registro no changelog.

Esta página em Markdown · llms.txt