Versionamento
O que pode mudar dentro da v1, o que nunca muda sem uma versão nova e como ficar sabendo.
A versão da API está no endereço: /external-api/v1.
O que pode mudar dentro da v1
- Campos novos nas respostas. Seu código deve ignorar campos que não conhece.
- Endpoints e parâmetros novos, sempre opcionais.
- Códigos de erro novos. Trate um
codedesconhecido pelo status HTTP. - Textos do
detail.
O que só muda numa versão nova
- Remover ou renomear um campo, parâmetro, endpoint ou código de erro.
- Mudar o tipo ou o significado de um campo.
- Tornar obrigatório um parâmetro que era opcional.
Se um dia existir uma v2, a v1 continua no ar por um período de transição anunciado em
Novidades.
Como ficar sabendo
Toda mudança da API entra em Novidades com a data. Esta documentação é gerada do próprio código do BIX e publicada junto com cada versão em produção: o que está aqui é o que a API faz.