# Versionen und Kompatibilität

> Was sich in /v1 ohne Vorankündigung ändert, was 30 Tage vorher angekündigt wird und wo Sie die Neuigkeiten verfolgen.

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

Die API trägt ihre Version im Pfad, `/v1`, und ein Datum: das des OpenAPI-Dokuments (`info.version`), den Tag seiner
letzten Änderung. Jede Änderung hat ihren Eintrag unter [Neuigkeiten](https://developers.vimine.network/de/news/).

## Kompatible Änderungen

Sie kommen in `/v1`, sobald sie fertig sind, mit ihrem Eintrag am selben Tag:

- ein neuer Endpunkt, ein neues Feld in einer Antwort, ein neuer optionaler Parameter oder ein neues optionales Feld in
  einer Anfrage;
- ein neuer Wert eines Strings, den die Referenz als offen beschreibt (wie `payment.method`), und ein neuer
  Fehler-`code`;
- eine neue Berechtigung (Scope) und eine neue Sprache.

Damit keine davon Ihre Integration bricht: Ignorieren Sie Felder, die Sie nicht kennen, behandeln Sie einen unbekannten
Wert eines offenen Strings als allgemeinen Fall, und sehen Sie einen Zweig für die Fehler-`code`s vor, die Sie nicht
einzeln behandeln.

Die Seiten von Vimine (die Anmeldung, das Beitrittsformular, die Agenda) können ihr Aussehen jederzeit ändern; ihre
Adressen und die Parameter, die sie annehmen, folgen denselben Regeln wie die API.

## Änderungen, die ein Handeln erfordern

Ein entferntes oder umbenanntes Feld, ein Parameter, der Pflicht wird, eine Antwort, die ihre Bedeutung ändert: Eine
solche Änderung wird mindestens **30 Tage** vorher angekündigt, mit einem Eintrag *Handlungsbedarf*, der sagt, was bis
wann zu ändern ist, und mit einer E-Mail an Entwicklerkonten und an alle, die einen Verein mit einer aktiven App leiten.
Wenn sie kommt, sagt es ein zweiter Eintrag.

Während der Beta kommt eine solche Änderung in `/v1`. Nach der Beta kommt sie in einer neuen Version, `/v2`, neben
`/v1` für mindestens sechs Monate.

## Das SDK und das WordPress-Plugin

- `@vimine/sdk`: Solange die Version 0.x ist, verlangt ein Patch (0.3.6) nie, dass Sie Ihren Code ändern; eine
  Minor-Version (0.4.0) kann es, und ihr Eintrag sagt, was. Die Einträge stehen auch im Paket, in `CHANGELOG.md`.
- Das WordPress-Plugin wird über WordPress.org aktualisiert, wo seine Seite dieselben Einträge zeigt.

## Neuigkeiten verfolgen

- Die Seite [Neuigkeiten](https://developers.vimine.network/de/news/) und ihr Atom-Feed, in jeder Sprache des Portals: `/de/news.xml` auf Deutsch,
  `/news.xml` auf Italienisch und so weiter.
- In der Vimine-Konsole zeigt **Entwickler** die neuesten Einträge.
- Einträge mit *Handlungsbedarf* kommen auch per E-Mail.