Änderungen von Dokument Submission-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 ProForms stellt eine Schnittstelle zur Verfügung, die die Daten aller im System hinterlegten Einreichungen ausliest. Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH ProForms angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben.
	3	+MACH formsolutions stellt eine Schnittstelle zur Verfügung, die die Daten aller im System hinterlegten Einreichungen ausliest. Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH formsolutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben.
4	4
5	5	## Voraussetzungen
6	6
...	...	@@ -14,7 +14,7 @@
14	14
15	15	## Authentifizierung
16	16
17		-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.
	17	+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 Formular-Servers beantragt werden.
18	18
19	19	Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
20	20	_**Mandantennummer:**_ 77777777-0000
...	...	@@ -28,7 +28,11 @@
28	28
29	29	Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: <https://vertrieb.form-solutions.de/submission/api/swagger-ui/index.html>
30	30
31		-> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den MACH ProFormss internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/submission/swagger-ui/index.html
	31	+> _**Achtung**_
	32	+>
	33	+> Die oben verlinkte Swagger-Dokumentation ist beispielhaft und wird von einem Server der MACH abgerufen.
	34	+>
	35	+> Um die Dokumentation eines anderen Servers einzusehen, ändern Sie die URL nach folgendem Format: `< SERVER_BASIS_URL >/submission/swagger-ui/index.html`
32	32
33	33	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
34	34
...	...	@@ -36,7 +36,7 @@
36	36
37	37	_**organizationID:**_ 77777777-0000
38	38	_**Identifier:**_ KFAS_SubmissionAPI_Test_WithUpload
39		-_**transactionID:**_ KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb
	43	+_**transactionID:**_ KFAS_SubmissionAPI_Test_WithUpload-n3tUuc4L
40	40	_**messageID:**_ 6050a243756f151657af46a4
41	41	_**fileID:**_ 6050a2e8756f151657af46a6
42	42