Zum Inhalt springen
Garanify

Versionierung

Die Hauptversion steht im Pfad (/v1). Die genaue Version steht in jeder Antwort im Header Garanify-Api-Version, aktuell 1.0.0.

Die API ist gebaut und getestet. Das Hosting unter api.garanify.com ist in Vorbereitung; bis dahin läuft sie lokal. Schlüssel gibt es auf Anfrage.

Was sich in v1 ändern darf

Diese Änderungen kommen ohne Vorwarnung. Ihr Client sollte unbekannte Felder und Werte ignorieren:

  • neue Endpunkte
  • neue optionale Felder in Anfragen
  • neue Felder in Antworten
  • neue Fehlercodes und neue Werte in Aufzählungen von Antworten
  • neue Header
  • andere Texte in title und detail

Was nur in einer neuen Hauptversion kommt

  • Felder oder Endpunkte entfernen oder umbenennen
  • neue Pflichtfelder in Anfragen
  • Typ oder Bedeutung eines Felds ändern
  • strengere Prüfung bestehender Felder
  • Schlüsselformate oder Authentifizierung ändern

Eine neue Hauptversion bekommt einen neuen Pfad (/v2). /v1 läuft danach mindestens 12 Monate weiter.

Abkündigung

Wir kündigen Endpunkte oder Felder mindestens 12 Monate vorher an: im Changelog, per Mail an die Kontoinhaber und in jeder betroffenen Antwort mit den Headern Deprecation (RFC 9745) und Sunset (RFC 8594). Pflichtangaben, die das Recht verlangt, schalten wir nie ohne Ersatz ab.

Beispiel
HTTP/1.1 200 OK
Garanify-Api-Version: 1.4.0
Deprecation: @1798761600
Sunset: Thu, 31 Dec 2027 23:59:59 GMT
Link: <https://garanify.com/en/developers/versioning/>; rel="deprecation"

Changelog

Jede Änderung mit Datum steht im Changelog der API.

Die Änderungen der Plugins und der Website stehen im allgemeinen Changelog. Die Spezifikation jeder Version: openapi.yaml, Hinweise zu Fehlern unter Fehler und Codes.