Zum Hauptinhalt springen
Die Automation API verwendet semantische Versionierung.

​
Über die Versionierung der gesamten API

Breaking Changes treten nur in neuen Hauptversionen der API auf, mit folgenden Ausnahmen:
  • Endpoints, die noch nicht verwendet werden, können in einer Nebenversion (1.x) Breaking Changes enthalten.
  • Kritische Sicherheitskorrekturen, die die Abwärtskompatibilität brechen, können in einer Nebenversion veröffentlicht werden. Überprüfen Sie alle API-Änderungen im Changelog.
Breaking Changes umfassen die folgenden Arten von Änderungen:
  • Entfernen einer gesamten Operation.
  • Entfernen oder Umbenennen eines Parameters.
  • Entfernen oder Umbenennen eines Antwortfeldes.
  • Hinzufügen eines neuen erforderlichen Parameters.
  • Einen zuvor optionalen Parameter erforderlich machen.
  • Ändern des Typs eines Parameters oder eines Antwortfeldes.
  • Entfernen von Enum-Werten.
  • Hinzufügen einer neuen Validierungsregel zu einem bestehenden Parameter.
  • Ändern der Authentifizierungs- oder Autorisierungsanforderungen.
Alle additiven (nicht brechenden) Änderungen sind in allen unterstützten API-Versionen verfügbar. Additive Änderungen sind Änderungen, die eine Integration nicht beeinträchtigen sollten. Additive Änderungen umfassen:
  • Hinzufügen einer Operation.
  • Hinzufügen eines optionalen Parameters.
  • Hinzufügen eines optionalen Anfrage-Headers.
  • Hinzufügen eines Antwortfeldes.
  • Hinzufügen eines Antwort-Headers.
  • Hinzufügen von Enum-Werten.
Wenn Kameleoon eine neue Haupt-API-Version veröffentlicht, bleibt die vorherige Version mindestens drei Monate lang unterstützt.

​
Eine API-Version angeben

Standardmäßig verwendet https://api.kameleoon.com die aktuellste API-Version. Geben Sie eine Version an, indem Sie sie in die URL einbeziehen (zum Beispiel https://api.kameleoon.com/v1/). Die nächste Hauptversion wird nach ihrer Veröffentlichung unter https://api.kameleoon.com/v2 verfügbar sein.

​
Über die Versionierung pro Endpoint

Einige Endpoints unterstützen die Angabe einer Version. Beispielsweise kann eine neuere Version eines bestimmten Endpoints gegenüber der Standard-API-Version bevorzugt werden. Verwenden Sie, wo verfügbar, den Parameter version, um die gewünschte Endpoint-Version anzugeben. Wenn eine neue Hauptversion veröffentlicht wird, werden alle früheren Versionen entfernt. Wenn ein Endpoint beispielsweise in der API-Version 1.0.0 die Version 1 und Version 2 hat, enthält die API-Version 2.0.0 nur die neueste Version dieses Endpoints.