Pular para o conteúdo principal
A versão da API está no caminho: https://api.zouti.com.br/v1. Dentro da v1, a API só recebe mudanças aditivas: o que já existe continua funcionando do mesmo jeito.

O que pode mudar na v1

  • Campos novos no objeto, inclusive dentro de objetos aninhados como payment ou customer.
  • Valores novos em listas de valores: status, payment.status, payment.method, payment.card.brand e as demais.
  • Parâmetros opcionais novos nas rotas existentes.
  • Recursos novos, com rotas novas.

O que não muda na v1

Campo, parâmetro ou valor existente não muda de significado nem é removido dentro da v1. Uma mudança incompatível (remover um campo, mudar o significado de um valor, tornar um parâmetro obrigatório) só entra numa versão nova, num caminho novo (/v2). As mudanças da API ficam registradas no Changelog.

Como se proteger

Para não quebrar com as mudanças aditivas, a sua integração deve:
  • Ignorar campos que não conhece. Leia só os campos que usa. Não valide a resposta com um schema que recuse propriedades extras.
  • Aceitar valores desconhecidos de enum. Um status novo não pode derrubar a integração: trate-o num caso padrão (por exemplo, registre e siga) em vez de lançar erro.
  • Não depender da ordem dos campos no JSON.
  • Não depender do texto de error.message. Trate os erros pelo code; a mensagem pode mudar.
O código ao lado lê só os campos que usa e mapeia o status com um caso padrão.