Versionierung

Wie sich die API ändert und wie wir Sie darüber informieren.

Die Version steht im Pfad: /api/v1.

Innerhalb von v1 nehmen wir nur Änderungen vor, die eine korrekte Integration nicht beeinträchtigen:

• neue Endpunkte;
• neue optionale Felder in Anfragen;
• neue Felder in Antworten;
• neue Fehlercodes und neue Werte von status.

Verarbeiten Sie Antworten tolerant: Ignorieren Sie Felder, die Sie nicht kennen.

Eine inkompatible Änderung erhält eine neue Version (/api/v2). Wir kündigen sie den Inhabern von API-Konten im Voraus an.

Die maschinenlesbare Beschreibung der API finden Sie unter /api/v1/openapi.json, für Postman oder einen Client-Generator.