Änderungen von Dokument Release-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,92 +1,66 @@
1	1	## Allgemeines
2	2
3		-Form-Solutions 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 Form-Solutions 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.
4		-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.
5		-Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt?
6		-Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt.
	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.
	4	+Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern.
	5	+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.
7	7
8	8	## Voraussetzungen
9	9
10		-Um die Release-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
11		-- Der Formularserver benötigt mindestens das Release mit der Version 4.46.0
12		-- Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
	9	+Um die Release-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
13	13
	11	+* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
	12	+
14	14	## Verwendung der Schnittstelle
15	15
	15	+Die API wurde nicht für den Browsergebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise [Insomnia](https://insomnia.rest/) oder [Postman](https://www.postman.com/) empfohlen.
	16	+
16	16	Da die Schnittstelle auf dem REST-Standard beruht, kann diese über eine URL erreicht werden. Hierbei gibt es einen festen Basispfad und einen entsprechenden Endpunkt. Der Basispfad ist bei jedem Aufruf gleich, wobei sich die Endpunkte je nach Funktion unterscheiden können. Ein Endpunkt spricht eine Funktionalität der Schnittstelle an. Da der Basispfad immer gleich ist, können über diverse Endpunkte mehrere Funktionalitäten in die Schnittstelle verbaut werden. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation.
17	17
18	18	## Einschränkungen
19	19
20		-Im derzeitigen Zustand hat die Schnittstelle folgende Einschränkungen:
21		-- Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
22		-- Fehlerhafte Konfigurationsfelder werden ausgeblendet
	21	+Zur Zeit gelten für die Schnittstelle folgende Einschränkungen:
23	23
24		-Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass
25		-- der Assistent seine Gültigkeitsperiode bereits begonnen hat
26		-- der Assistent seine Gültigkeitsperiode nicht beendet hat
	23	+* Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
	24	+* Fehlerhafte Konfigurationsfelder werden ausgeblendet
27	27
28		-Für PDF bedeutet das, dass
29		-- die aktuelle Formularversion aktiv ist
	26	+Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass
30	30
31		-Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen.
	28	+* die Gültigkeitsperiode für den Assistenten bereits begonnen hat
	29	+* die Gültigkeitsperiode des Assistenten noch nicht beendet ist
32	32
33		-## Ausgabeformate
	31	+Für PDF bedeutet das, dass
34	34
35		-Die Schnittstelle unterstützt insgesamt zwei unterschiedliche Ausgabeformate. Standardmäßig wird hier ein Dokument im JSON-Format ausgehändigt, während über einen Parameter im Header der Anfrage die Ausgabe im CSV-Format erzwungen werden kann.
	33	+* die aktuelle Formularversion aktiv ist
36	36
37		-### Ausgabe im JSON-Format
	35	+## Ausgabeformate
38	38
39		-Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format. Hierbei wird eine Ausgabe erzeugt, welche verschiedene Felder beinhaltet.
	37	+### Ausgabe im JSON-Format (Standard)
40	40
	39	+Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format.
	40	+
41	41	### Ausgabe im CSV-Format
42	42
43		-Mit dem Header-Parameter „accept“ kann die Ausgabe im CSV-Format erzwungen werden. Hierbei sollte der oben erwähnte Parameter wie folgt aufgebaut sein: "accept = text/csv". Auch hier beinhaltet die Ausgabe verschiedene Felder.
	43	+Mit dem Header-Parameter "accept = text/csv" kann die Ausgabe im CSV-Format erfolgen.
44	44
45	45	## Authentifizierung
46	46
47		-Um die Schnittstelle verwenden zu können, muss eine Authentifizierung vorgenommen werden. Für diese ist die Mandantennummer und der dafür hinterlegte API-Schlüssel notwendig, wobei die Mandantennummer als Benutzername und der API-Schlüssel als Passwort gilt. Sollte noch kein passender API-Schlüssel vorliegen, kann dieser beim Administrator des Fomularservers beantragt werden.
	47	+Um die Schnittstelle verwenden zu können, muss eine Authentifizierung vorgenommen werden. Für diese sind die Mandantennummer und ein API-Key notwendig, wobei die Mandantennummer als Benutzername und der API-Key als Passwort gilt. Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
48	48
49		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
50		-***Mandantennummer:*** 77777777-0000
51		-***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
	49	+Einen API-Key können Sie beim Betreiber des Formularservers beantragen.
52	52
53		-> {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:***
54		-> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
55		-
56	56	### Authentifizierung als Supermandant
57	57
58		-Bei der Authentifizierung als Supermandant liegen Berechtigungen auf alle im System hinterlegten Benutzer vor. Somit ist es möglich, alle Veröffentlichungen auf dem Formularserver mandantenübergreifend auszulesen. Gleichzeitig bietet die Schnittstelle über einen Parameter die Möglichkeit auch nur die Veröffentlichungen für einen oder mehrere Mandanten auszulesen. Dieses Verhalten wird über den Parameter "organizationId" gesteuert.
	53	+Bei der Authentifizierung als Supermandant liegen Berechtigungen auf alle im System hinterlegten Mandanten vor. Somit ist es möglich, alle Veröffentlichungen auf dem Formularserver mandantenübergreifend auszulesen. Gleichzeitig bietet die Schnittstelle über den Parameter "organizationId" die Möglichkeit, jeweils nur die Veröffentlichungen für einen oder mehrere Mandanten auszulesen.
59	59
60		-#### Aufruf ohne Parameter "organizationId"
61		-
62		-***Pfadbeispiel:*** https://<server-name>/release-api/releases
63		-***Beschreibung:*** Wird die Schnittstelle als Supermandant ohne den Parameter "organizationId" aufgerufen, so werden alle Veröffentlichungen aller im Formularserver hinterlegten Mandanten ausgelesen. Dies betrifft sowohl Assistenten als auch PDF-Formulare.
64		-
65		-#### Aufruf mit Parameter "organizationId"
66		-
67		-***Pfadbeispiel:*** https://<server-name>/release-api/releases?organizationId=12345678-1234
68		-***Beschreibung:*** Wird die Schnittstelle als Supermandant mit dem Parameter "organizationId" aufgerufen, so werden alle Veröffentlichungen für den in dem Parameter aufgeführten Mandanten ausgelesen. Dies betrifft sowohl Assistenten als auch PDF-Formulare. Zusätzlich zu dieser Funktion können auch mehrere Mandantennummern kommasepariert als Wert des Parameters eingetragen werden. Somit würden alle Veröffentlichungen der angegebenen Mandantennummern ausgelesen werden.
69		-
70	70	### Authentifizierung als einzelner Mandant
71	71
72		-Bei der Authentifizierung als einzelner Mandant liegen Berechtigungen auf alle Veröffentlichungen des eigenen Mandanten vor. Um die Schnittstelle nach einer solchen Authentifizierung nutzen zu können, wird die oben beschriebene Basis-URL sowie der gewünschte Endpunkt verwendet.
	57	+Bei der Authentifizierung als einzelner Mandant liegen Berechtigungen auf alle Veröffentlichungen des eigenen Mandanten vor. Es werden die Veröffentlichungen von Assistenten und PDF-Formularen des authentifizierten Mandanten übergeben.
73	73
74		-***Pfadbeispiel:*** https://<server-name>/release-api/releases
75		-
76		-Da wir mit dieser Art der Authentifizierung bereits eindeutig als Mandant identifiziert sind, wird an dieser Stelle keine Filterung der Mandanten über einen gesonderten Parameter benötigt. Mit der Nutzung der oben beschriebenen URL werden nun alle Veröffentlichungen von Assistenten und PDF-Formularen des angemeldeten Mandanten ausgehändigt.
77		-
78	78	## Beispielanwendung (Swagger-Dokumentation)
79	79
80		-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
	61	+Auf dem Formularserver ist mit der Swagger-Anwendung eine übersichtliche Darstellung und technische Dokumentation der Schnittstelle verfügbar. Mit dieser Anwendung kann die Funktionalität auch getestet werden.
81	81
82		-> ***Achtung***
83		-> Die oben verlinkte Swagger-Dokumentation greift auf den Form-Solutions internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/release-api/swagger-ui/index.html
	63	+Die Adresse der Swagger-Anwendung der Release-API lautet `< Formularserveradresse >/release-api/swagger-ui/index.html`
	64	+Um die Anwendung aufzurufen, setzen Sie die Adresse des jeweiligen Formularservers ein.
84	84
85		-Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
86		-
87		-### Testdaten zu Demonstrationszwecken
88		-
89		-***organizationID:*** 77777777-0000
90		-***secureID (Assistent):*** 6050847cb2e9650a8ab19c83
91		-***secureID (PDF):*** zGVrF5v6N8XzH5j7kJN84qtKrM8TA9A
92		-
	66	+Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).