Änderungen von Dokument Submission-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -14,50 +14,33 @@
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 Formular-Servers beantragt werden.
	17	+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.
18	18
19		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
20		-_**Mandantennummer:**_ 77777777-0000
21		-_**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK
	19	+Einen API-Key können Sie beim Betreiber des Formularservers beantragen.
22	22
23		-> {{icon name="far fa-info-circle" size="3"/}} **Hinweis:**
24		->
25		-> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
26		-
27	27	## Beispielanwendung (Swagger-Dokumentation)
28	28
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>
	23	+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.
30	30
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`
	25	+Die Adresse der Swagger-Anwendung der Submission-API lautet `< Formularserveradresse >/submission/swagger-ui/index.html`
	26	+Um die Anwendung aufzurufen, setzen Sie die Adresse des jeweiligen Formularservers ein.
36	36
37		-Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
	28	+Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).
38	38
39		-### Testdaten zu Demonstrationszwecken
	30	+## Datenabholung durch (mehrere) Systeme mit Status koordinieren
40	40
41		-_**organizationID:**_ 77777777-0000
42		-_**Identifier:**_ KFAS_SubmissionAPI_Test_WithUpload
43		-_**transactionID:**_ KFAS_SubmissionAPI_Test_WithUpload-n3tUuc4L
44		-_**messageID:**_ 6050a243756f151657af46a4
45		-_**fileID:**_ 6050a2e8756f151657af46a6
	32	+### Beispiel 1: Abholung eines Detaildatensatzes durch ein einzelnes externes System
46	46
47		-## Anwendungsbeispiele
	34	+Greift ein einzelnes externes System (beispielsweise eine Portalsoftware) auf einen Detaildatensatz für die weitere Verarbeitung zu, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "DELETED" zu setzen.
48	48
49		-### Anwendungsbeispiel 1
	36	+### Beispiel 2: Einsicht und Abholung von Detaildatensätzen durch ein externes System
50	50
51		-**Abholung eines Detaildatensatzes durch ein einzelnes externes System** Greift ein einzelnes externes System (beispielsweise eine Portalsoftware) auf einen Detaildatensatz für die weitere Verarbeitung zu, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "DELETED" zu setzen.
	38	+Greift ein externes System (beispielsweise eine Portalsoftware) auf die Übersicht aller Einreichungen eines spezifischen Assistenten zu, ist der Status der ermittelten Datensätze von "NEW" auf "READ" zu setzen. Wird ein Detaildatensatz für die weitere Verarbeitung im externen System abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "READ" auf "DELETED" zu setzen.
52	52
53		-### Anwendungsbeispiel 2
	40	+### Beispiel 3: Abholung von Detaildatensätzen durch zwei externe Systeme
54	54
55		-**Einsicht und Abholung von Detaildatensätzen durch ein externes System:** Greift ein externes System (beispielsweise eine Portalsoftware) auf die Übersicht aller Einreichungen eines spezifischen Assistenten zu, ist der Status der ermittelten Datensätze von "NEW" auf "READ" zu setzen. Wird ein Detaildatensatz für die weitere Verarbeitung im externen System abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "READ" auf "DELETED" zu setzen.
	42	+Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen. Greift ein weiteres System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „DELETED“ zu setzen.
56	56
57		-### Anwendungsbeispiel 3
	44	+### Beispiel 4: Abholung von Detaildatensätzen durch drei externe Systeme
58	58
59		-**Abholung von Detaildatensätzen durch zwei externe Systeme:** Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen. Greift ein weiteres System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „DELETED“ zu setzen.
60		-
61		-### Anwendungsbeispiel 4
62		-
63		-**Abholung von Detaildatensätzen durch drei externe Systeme:** Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen. Greift ein zweites System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „PRELIMINARY“ zu setzen. Greift ein drittes System (beispielsweise eine Software zur Benachrichtigung des Antragstellers über das Ergebnis) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „PRELIMINARY“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „PRELIMINARY“ auf „DELETED“ zu setzen.
	46	+Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen. Greift ein zweites System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „PRELIMINARY“ zu setzen. Greift ein drittes System (beispielsweise eine Software zur Benachrichtigung des Antragstellers über das Ergebnis) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „PRELIMINARY“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „PRELIMINARY“ auf „DELETED“ zu setzen.