Änderungen von Dokument Schnittstellen

Zuletzt geändert von MACH ProForms GmbH am 10.12.2024

Von Version 93.1
bearbeitet von MACH ProForms GmbH
am 09.12.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 94.1
bearbeitet von MACH ProForms GmbH
am 09.12.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -23,3 +23,18 @@
23 23  # Versionierung
24 24  
25 25  Grundsätzlich legen wir unsere API's für eine möglichst lange Betriebsphase und somit für eine lange Versionskompatibilität aus. Im Nachfolgenden finden Sie unsere Vorgehensweise im Detail.
26 +
27 +Wir behalten (soweit technisch möglich) immer die zwei Versionen online. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach der Abkündigung wird die Version und alle beinhalteten Minor-Versionen nicht mehr erreichbar sein.
28 +
29 +Eine neue Major-Version kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen. Dies sind z.B.:
30 +
31 +* Zugang
32 +* Endpunkte
33 +* Parameter
34 +* Response
35 +
36 +Eine neue Minor-Version ist per Definition abwärtskompatibel zur Major-Version. Dabei können Sie aber folgende Dinge ändern:
37 +
38 +* Zusätzliche Endpunkte
39 +* Weitere Parameter für eine Abfrage (z.B. Filterfunktion)
40 +* Erweitertes Response (weitere Ausgaben in der Antwort)