Documentation Index
Fetch the complete documentation index at: https://docs.vmarea.com/llms.txt
Use this file to discover all available pages before exploring further.
Versionamento por caminho
A API pública da VMArea usa versionamento por caminho. Todos os endpoints atuais estão sob:Política de compatibilidade retroativa
O que muda dentro de uma versão principal?
O que muda dentro de uma versão principal?
Dentro de uma versão principal (
v1), a VMArea se compromete apenas com mudanças aditivas:- Novos campos opcionais de requisição podem ser adicionados.
- Novos campos de resposta podem ser adicionados (projete seu cliente para ignorar campos desconhecidos).
- Novos endpoints podem ser adicionados.
- Novos tipos de evento podem ser adicionados à lista de eventos de webhook.
O que é considerado uma mudança quebrando?
O que é considerado uma mudança quebrando?
Mudanças quebrando — remoção de campos, alteração de tipos, renomeação de endpoints, mudança no comportamento de autenticação — só serão introduzidas em uma nova versão principal (
v2 etc.).Por quanto tempo uma versão mais antiga é suportada?
Por quanto tempo uma versão mais antiga é suportada?
Quando uma nova versão principal for lançada, a versão anterior terá suporte por no mínimo 6 meses a partir da data do anúncio, dando tempo para migrar. Os prazos de descontinuação são anunciados no registro de mudanças.