> ## 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

> Como a API pública da VMArea é versionada e qual é a política de compatibilidade retroativa.

## Versionamento por caminho

A API pública da VMArea usa versionamento por caminho. Todos os endpoints atuais estão sob:

```
https://api.vmarea.com/api/public/v1/
```

O segmento de versão faz parte de cada URL. Não há negociação de conteúdo nem seleção de versão por cabeçalho.

## Política de compatibilidade retroativa

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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.).
  </Accordion>

  <Accordion title="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.
  </Accordion>
</AccordionGroup>

## Registro de mudanças

Em breve. As entradas do registro serão publicadas em [docs.vmarea.com](https://docs.vmarea.com) quando disponíveis.