Änderungen von Dokument Schnittstellen

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -12,33 +12,11 @@
12	12	* Die Dokumentation der „[[Release-API|Main.02_FSSchnittstellen.02_ReleaseAPI]]“
13	13	* Die Dokumentation der „[[Submission-API|Main.02_FSSchnittstellen.01_SubmissionAPI]]“
14	14	* Die Dokumentation der „[[Error-API|Main.02_FSSchnittstellen.04_ErrorAPI]]“
15		-
16		-## Veraltete API's
17		-
18		-* Die Dokumentation der „[[Search-API-Metaform|Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“
19		-* Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API|Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“
20	20	* Die Dokumentation der „[[CMS-Schnittstelle|Main.02_FSSchnittstellen.05_CMSSchnittstelle]]“
21	21	* Die Dokumentation der „[[PDF Structure-API|Main.02_FSSchnittstellen.07_PDFStructureAPI]]“
	17	+* Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API|Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“
	18	+* Die Dokumentation der „[[Search-API-Metaform|Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“
22	22
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 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 (1.x)** kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen (Abhängig von Ihrer Implementierung). Dies sind z.B.:
30		-
31		-* Authentifizierungsmethoden
32		-* Umbenennung und Löschung von Endpunkten
33		-* Umbenennung und Löschung von Parametern
34		-* Restrukturierung des Response-Objekt
35		-
36		-Eine neue **Minor-Version (x.1)** ist per Definition abwärtskompatibel zur **Major-Version**. Dabei können sich aber folgende Dinge ändern:
37		-
38		-* Zusätzliche Endpunkte
39		-* Weitere (optionale) Parameter für eine Abfrage (z.B. Filterfunktion)
40		-* Erweitertes Response-Objekt
41		-
42		-# Versionshistorie
43		-
44		-Zu jeder API finden Sie als Unterknoten jeweils den "Release-Notes"-Artikel. Beispiel [[Submission-API|doc:.01_SubmissionAPI.Release-Notes.WebHome]].