Änderungen von Dokument Release-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,6 +1,6 @@
1	1	## Allgemeines
2	2
3		-MACH formsolutions stellt eine Schnittstelle zur Verfügung, die alle im System hinterlegten Veröffentlichungen ausliest. Diese Veröffentlichungen beinhalten sowohl Assistenten als auch PDF-Formulare. Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern. Wie bei allen von MACH formsolutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Hierbei werden die Zugriffsberechtigungen auf die getätigte Anfrage geprüft und sichergestellt, dass keine Dokumente ausgeliefert werden, auf die der Zugriff verweigert ist. Eine Besonderheit hierbei stellt der Supermandant dar, welcher als übergeordnete Instanz Zugriff auf alle unterliegenden Mandanten hat. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben. Wir stellen seit dem Release [4.62.0](https://wiki.form-solutions.de/wiki/docwiki/view/Main/13_Release-Notes/) mehrere Versionen der Release-API zur Verfügung. Die ausführliche Dokumentation finden Sie im Rahmen der Swagger-Dokumentation. Den Link hierfür finden Sie am Ende der Seite. Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt? Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt.
	3	+MACH ProForms stellt eine Schnittstelle zur Verfügung, die alle im System hinterlegten Veröffentlichungen ausliest. Diese Veröffentlichungen beinhalten sowohl Assistenten als auch PDF-Formulare. Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern. Wie bei allen von MACH ProForms angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Hierbei werden die Zugriffsberechtigungen auf die getätigte Anfrage geprüft und sichergestellt, dass keine Dokumente ausgeliefert werden, auf die der Zugriff verweigert ist. Eine Besonderheit hierbei stellt der Supermandant dar, welcher als übergeordnete Instanz Zugriff auf alle unterliegenden Mandanten hat. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben. Wir stellen seit dem Release [4.62.0](https://wiki.form-solutions.de/wiki/docwiki/view/Main/13_Release-Notes/) mehrere Versionen der Release-API zur Verfügung. Die ausführliche Dokumentation finden Sie im Rahmen der Swagger-Dokumentation. Den Link hierfür finden Sie am Ende der Seite. Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt? Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt.
4	4
5	5	## Voraussetzungen
6	6
...	...	@@ -15,7 +15,7 @@
15	15
16	16	## Einschränkungen
17	17
18		-Zur Zeit gelten für die Schnittstelle folgende Einschränkungen:
	18	+Im derzeitigen Zustand hat die Schnittstelle folgende Einschränkungen:
19	19
20	20	* Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
21	21	* Fehlerhafte Konfigurationsfelder werden ausgeblendet
...	...	@@ -81,11 +81,7 @@
81	81
82	82	Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: <https://vertrieb.form-solutions.de/release-api/swagger-ui/index.html>
83	83
84		-> _**Achtung**_
85		->
86		-> Die oben verlinkte Swagger-Dokumentation ist beispielhaft und wird von einem Server der MACH abgerufen.
87		->
88		-> Um die Dokumentation eines anderen Servers einzusehen, ändern Sie die URL nach folgendem Format: `< SERVER_BASIS_URL >/release-api/swagger-ui/index.html`
	84	+> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den internen Vertriebsserver der MACH ProForms GmbH zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/release-api/swagger-ui/index.html
89	89
90	90	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
91	91