Zum Inhalt springen

Grundlagen

Versionierung und Abkündigung

Die Hauptversion ist Teil des Pfads: /api/partner/v1. Innerhalb von v1 ändert sich die API nur so, dass bestehende Integrationen weiterlaufen.

Änderungen ohne neue Version

  • Neue Endpunkte, neue optionale Parameter und neue optionale Request-Felder
  • Neue Felder in Antworten und Webhook-Payloads
  • Neue Webhook-Ereignisse (du erhältst nur abonnierte)
  • Neue Werte in als erweiterbar dokumentierten Feldern und neue Fehlercodes unter Fehler

Inkompatible Änderungen

Felder entfernen oder umbenennen, Typen oder Bedeutungen ändern oder Validierung verschärfen gibt es nur in einer neuen Hauptversion (v2). Die bisherige Version läuft parallel weiter.

Abkündigung

Bevor etwas entfällt, kündigen wir es mindestens sechs Monate vorher im Änderungsprotokoll an. Betroffene Antworten tragen einen Deprecation-Header und einen Sunset-Header mit dem Datum, ab dem der Endpunkt entfallen kann.

HTTP
HTTP/1.1 200 OK
Deprecation: @1798761600
Sunset: Wed, 30 Jun 2027 00:00:00 GMT
Link: <https://staystryk.com/developers/changelog>; rel="deprecation"

Protokolliere diese Header in deiner Integration, damit eine Abkündigung nicht unbemerkt bleibt.