Änderungen von Dokument Release-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,7 +1,7 @@
1	1	## Allgemeines
2	2
3	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|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.
	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	5	Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt?
6	6	Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt.
7	7
...	...	@@ -46,9 +46,9 @@
46	46
47	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.
48	48
49		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
50		-***Mandantennummer:*** 77777777-0000
51		-***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
	49	+Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
	50	+***Mandantennummer:*** 77777777-0000
	51	+***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
52	52
53	53	> {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:***
54	54	> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
...	...	@@ -59,12 +59,12 @@
59	59
60	60	#### Aufruf ohne Parameter "organizationId"
61	61
62		-***Pfadbeispiel:*** https://<server-name>/release-api/releases
	62	+***Pfadbeispiel:*** https://<server-name>/release-api/releases
63	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	64
65	65	#### Aufruf mit Parameter "organizationId"
66	66
67		-***Pfadbeispiel:*** https://<server-name>/release-api/releases?organizationId=12345678-1234
	67	+***Pfadbeispiel:*** https://<server-name>/release-api/releases?organizationId=12345678-1234
68	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	69
70	70	### Authentifizierung als einzelner Mandant
...	...	@@ -79,11 +79,14 @@
79	79
80	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
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 >/submission/swagger-ui/index.html
	84	+
82	82	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
83	83
84	84	### Testdaten zu Demonstrationszwecken
85	85
86		-***organizationID:*** 77777777-0000
87		-***secureID (Assistent):*** 6050847cb2e9650a8ab19c83
88		-***secureID (PDF):*** zGVrF5v6N8XzH5j7kJN84qtKrM8TA9A
	89	+***organizationID:*** 77777777-0000
	90	+***secureID (Assistent):*** 6050847cb2e9650a8ab19c83
	91	+***secureID (PDF):*** zGVrF5v6N8XzH5j7kJN84qtKrM8TA9A
89	89