Versionamento da API

Estamos sempre adicionando recursos e fazendo melhorias em nossa API, mas não permitiremos que seu aplicativo pare de funcionar por causa de uma alteração que fizermos em nossa API. Então caso façamos uma alteração significativa em um endpoint, lançaremos uma nova versão da API. Até hoje não precisamos fazer uma mudança nesses moldes, então permanecemos na v1.

Versão atual da API: v1

Consideramos as seguintes alterações compatíveis com versões anteriores:

  • Adicionar novos endpoints na API;

  • Adicionar novos parâmetros opcionais na requisição;

  • Tornar um parâmetro obrigatório da requisição em opcional;

  • Adicionar novas propriedades às respostas API existentes;

  • Adicionar novos eventos a webhooks (isso significa que seu endpoint de webhook deve lidar com tipos de eventos desconhecidos, por exemplo ignorando-os com um retorno status 200).

Sempre que lançarmos novidades enviaremos por e-mail.

Dicas Extras

  1. Não trabalhamos com "strings nulas"! Quando algum campo é definido como string em nossa API, você não pode defini-lo como null. Assim, caso queira que o campo seja vazio, não o envie em sua requisição, ou o envie como string vazia ("").

  2. true e false (booleanos) não é o mesmo que "true" e "false" (strings). Isso irá te poupar alguns testes frustrados...

  3. Horários em UTC+0: nosso servidor salva as datas e horários em UTC+0. Se quiser demonstrar horários aos seus usuários, considere que o Brasil é UTC-03:00 (a maioria dos frameworks e/ou navegadores realizam automaticamente essa conversão com os objetos de datetime).