API
Versionierung
Stabilitätszusagen und Umgang mit API-Änderungen.
Die aktuelle Version ist v2, erkennbar am URL-Präfix /v2/ — z. B. https://api.poliscope.de/v2/meetings. Sie ist die empfohlene Version für externe Integrationen.
Was sich nicht ändert
Innerhalb von v2 garantieren wir:
- Bestehende Endpunkte bleiben unter ihrer URL erreichbar
- Bestehende Felder behalten ihren Typ und ihre Bedeutung
- Status-Codes pro Endpunkt bleiben konsistent
Was sich ändern kann
Folgendes ist additiv und kann jederzeit ohne Vorankündigung passieren:
- Neue Endpunkte
- Neue optionale Query-Parameter
- Neue Felder in Antworten
Schreibe Clients tolerant: ignoriere unbekannte Felder, hänge keine Logik an die exakte Reihenfolge von Listen, und gehe nicht davon aus, dass nullable Felder immer einen Wert haben.
Breaking Changes
Inkompatible Änderungen erscheinen ausschließlich in einer neuen Major-Version. Innerhalb von v2 gibt es keine Breaking Changes.
Eine neue Major-Version ist aktuell nicht geplant. Sollte sie nötig werden, gilt:
- frühzeitige Ankündigung an alle aktiven API-Nutzer
- die alte Version bleibt mindestens 12 Monate parallel erreichbar
- Deprecations werden über die Response-Header
DeprecationundSunsetsignalisiert (RFC 9745) - bei Bedarf unterstützen wir die Migration direkt