Änderungen von Dokument Schnittstellen

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -2,9 +2,9 @@
2	2
3	3	![[Schnittstellen|@Schnittstellen.jpg]]
4	4
5		-# Übersicht der API's
	5	+# Übersicht der APIs
6	6
7		-## Aktuelle API's
	7	+## Aktuelle APIs
8	8
9	9	* Die Dokumentation zum Anlegen von „[[API-Keys|Main.02_FSSchnittstellen.09_API-Key]]“ für Nutzung der Schnittstellen
10	10	* Die Dokumentation der „[[Server-Information-API|Main.02_FSSchnittstellen.10_ServerInformationAPI]]“
...	...	@@ -13,7 +13,7 @@
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	15
16		-## Veraltete API's
	16	+## Veraltete APIs
17	17
18	18	* Die Dokumentation der „[[Search-API-Metaform|Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“
19	19	* Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API|Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“
...	...	@@ -22,23 +22,25 @@
22	22
23	23	# Versionierung
24	24
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.
	25	+Grundsätzlich legen wir unsere APIs für eine möglichst lange Betriebsphase aus und streben Versionskompatibilität an. Im Nachfolgenden finden Sie unsere Vorgehensweise im Detail.
26	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.
	27	+Wir behalten immer zwei Versionen online, soweit technisch möglich. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach dieser Frist sind die veraltete Version und alle ihre Minor-Versionen nicht mehr erreichbar.
28	28
29		-Eine neue Major-Version kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen. Dies sind z.B.:
	29	+Eine neue **Major-Version (1.x)** kann Änderungen beinhalten, die nicht abwärtskompatibel sind. Dies sind z.B.:
30	30
31		-* Zugang
32		-* Endpunkte
33		-* Parameter
34		-* Response
	31	+* Authentifizierungsmethoden
	32	+* Umbenennung und Löschung von Endpunkten
	33	+* Löschung von HTTP-Methoden an vorhandenen Endpunkten
	34	+* Umbenennung und Löschung von Parametern
	35	+* Restrukturierung des Response-Objekt
35	35
36		-Eine neue Minor-Version ist per Definition abwärtskompatibel zur Major-Version. Dabei können Sie aber folgende Dinge ändern:
	37	+Eine neue **Minor-Version (x.1)** ist per Definition abwärtskompatibel zur **Major-Version**. Änderungen wären z.B.:
37	37
38	38	* Zusätzliche Endpunkte
39		-* Weitere Parameter für eine Abfrage (z.B. Filterfunktion)
40		-* Erweitertes Response (weitere Ausgaben in der Antwort)
	40	+* Zusätzliche HTTP-Methoden an Endpunkten
	41	+* Weitere (optionale) Parameter für eine Abfrage (z.B. Filterfunktion)
	42	+* Erweitertes Response-Objekt
41	41
42	42	# Versionshistorie
43	43
44		-Zu jeder API finden Sie als Unterknoten jeweils den "Release-Notes"-Artikel. Beispiel [[Submission-API|doc:.01_SubmissionAPI.Release-Notes.WebHome]].
	46	+Zu jeder unserer APIs finden Sie zukünftig jeweils einen untergeordneten "Release-Notes"-Artikel. Beispiel [[Submission-API: Release-Notes|doc:.01_SubmissionAPI.Release-Notes.WebHome]].