Änderungen von Dokument Schnittstellen

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.Dokumentation
	1	+xwiki:XWiki.fweise

Inhalt

...	...	@@ -1,44 +1,14 @@
1		-Die MACH ProForms GmbH setzt bei der Produktstrategie auf den API-First Ansatz. D.h., dass perspektivisch alle Funktionen über eine API erreichbar und ansteuerbar sind.
	1	+In diesem Teil der Dokumentation finden Sie:
2	2
3		-![[Schnittstellen|@Schnittstellen.jpg]]
4		-
5		-# Übersicht der API's
6		-
7		-## Aktuelle API's
8		-
9		-* Die Dokumentation zum Anlegen von „[[API-Keys|Main.02_FSSchnittstellen.09_API-Key]]“ für Nutzung der Schnittstellen
10		-* Die Dokumentation der „[[Server-Information-API|Main.02_FSSchnittstellen.10_ServerInformationAPI]]“
11		-* Die Dokumentation der „[[Search-API|Main.02_FSSchnittstellen.03_SearchAPI]]“
12		-* Die Dokumentation der „[[Release-API|Main.02_FSSchnittstellen.02_ReleaseAPI]]“
13	13	* Die Dokumentation der „[[Submission-API|Main.02_FSSchnittstellen.01_SubmissionAPI]]“
	4	+* Die Dokumentation der „[[Release-API|Main.02_FSSchnittstellen.02_ReleaseAPI]]“
	5	+* Die Dokumentation der „[[Search-API|Main.02_FSSchnittstellen.03_SearchAPI]]“
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]]“
	8	+* Die Dokumentation der „[[Search-API-Metaform|Main.02_FSSchnittstellen.06_SearchAPIMetaform]]“
21	21	* Die Dokumentation der „[[PDF Structure-API|Main.02_FSSchnittstellen.07_PDFStructureAPI]]“
	10	+* Die Dokumentation der „[[Massenverarbeitung von Formular-Eingängen-API|Main.02_FSSchnittstellen.08_MassenverarbeitungAPI]]“
	11	+* Die Dokumentation zum Anlegen von „[[API-Keys|Main.02_FSSchnittstellen.09_API-Key]]“ für Nutzung der Schnittstellen
	12	+* Die Dokumentation der „[[Server-Information-API|Main.02_FSSchnittstellen.10_ServerInformationAPI]]“
22	22
23		-# Versionierung
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.
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)
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]].
	14	+![[Schnittstellen|@Schnittstellen.jpg]]