# Versões e compatibilidade

> O que muda em /v1 sem aviso, o que é anunciado com 30 dias de antecedência e onde acompanhar as novidades.

URL: https://developers.vimine.network/pt/guides/versioning/

A API traz a versão no caminho, `/v1`, e uma data: a do documento OpenAPI (`info.version`), o dia da sua última
mudança. Cada mudança tem a sua entrada em [Novidades](https://developers.vimine.network/pt/news/).

## As mudanças compatíveis

Chegam em `/v1` quando estão prontas, com a sua entrada no mesmo dia:

- um novo endpoint, um novo campo numa resposta, um novo parâmetro ou campo opcional numa requisição;
- um novo valor de uma string que a referência descreve como aberta (como `payment.method`) e um novo `code` de erro;
- uma nova permissão (scope) e um novo idioma.

Para que nenhuma quebre a sua integração: ignore os campos que você não conhece, trate um valor desconhecido de uma
string aberta como um caso genérico e preveja um ramo para os `code` de erro que você não trata um a um.

As páginas do Vimine (a entrada, o formulário de adesão, a agenda) podem mudar de aparência a qualquer momento; os
endereços delas e os parâmetros que aceitam seguem as mesmas regras da API.

## As mudanças que pedem uma ação

Um campo removido ou renomeado, um parâmetro que passa a ser obrigatório, uma resposta que muda de sentido: uma mudança
assim é anunciada pelo menos **30 dias** antes de chegar, com uma entrada *Ação necessária* que diz o que mudar e até
quando, e com um e-mail para as contas de desenvolvedor e para quem dirige uma associação com um app ativo. Quando ela
chega, uma segunda entrada avisa.

Durante a beta, uma mudança assim chega em `/v1`. Depois da beta, ela virá numa nova versão, `/v2`, ao lado de `/v1`
por pelo menos seis meses.

## O SDK e o plugin do WordPress

- `@vimine/sdk`: enquanto a versão for 0.x, um patch (0.3.6) nunca pede que você mude o seu código; uma versão menor
  (0.4.0) pode pedir, e a entrada dela diz o quê. As entradas estão também no pacote, em `CHANGELOG.md`.
- O plugin do WordPress se atualiza pelo WordPress.org, onde a página dele traz as mesmas entradas.

## Acompanhar as novidades

- A página [Novidades](https://developers.vimine.network/pt/news/) e o feed Atom dela, em cada idioma do portal: `/pt/news.xml` em português,
  `/news.xml` em italiano, e assim por diante.
- No console do Vimine, **Desenvolvedores** mostra as últimas entradas.
- As entradas *Ação necessária* chegam também por e-mail.