Versionamento

Como a API muda e como avisamos você.

A versão fica no caminho: /api/v1.

Dentro da v1, só fazemos mudanças que não quebram uma integração correta:

• novos endpoints;
• novos campos opcionais na requisição;
• novos campos na resposta;
• novos códigos de erro e novos valores de status.

Leia as respostas de forma tolerante: ignore os campos que você não conhece.

Uma mudança incompatível ganha uma nova versão (/api/v2), anunciada com antecedência aos titulares de contas de API.

A descrição da API legível por máquina está em /api/v1/openapi.json, para o Postman ou um gerador de clientes.