Versionierung
Die Version steckt im Pfad: /api/developer/v1. Was du heute gegen v1 baust, läuft weiter, solange v1 besteht.
Nur additive Änderungen
Innerhalb von v1 kommen nur Änderungen dazu, die bestehende Clients nicht brechen:
- neue Endpunkte,
- neue Felder in Antworten,
- neue Werte in Feldern mit festen Werten, etwa neue Fehlercodes oder Ereignistypen.
Dein Client muss deshalb unbekannte Felder und Werte ignorieren. Bei einem unbekannten Fehlercode hilft der HTTP-Status, siehe Fehler.
Abkündigung
Das sagen wir zu: Soll ein Endpunkt, ein Feld oder ein Verhalten wegfallen, kündigen wir es mindestens 6 Monate vorher an. Betroffene Antworten tragen dann den Header Sunset mit dem Zeitpunkt, ab dem die Funktion abgeschaltet wird, und die Ankündigung steht im Changelog. Prüfe den Header in deinen Logs, damit du die Umstellung rechtzeitig planst.
Changelog
Änderungen an der Developer-API, die neueste zuerst.
| Version | Änderung |
|---|---|
| v1 | Erste Version der Developer-API: Server, Backups, Git, Bots und Webhooks mit Zugriffstokens und Bot-Tokens. |