Wiki-Quellcode von Submission-API

Zuletzt geändert von MACH ProForms GmbH am 25.06.2024

version	line-number	content
6.1	1	## Allgemeines
1.1	2
11.1	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.
1.1	4
6.1	5	## Voraussetzungen
1.1	6
6.1	7	Um die Submission-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
1.1	8
11.1	9	* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
	10
6.1	11	## Verwendung der Schnittstelle
5.1	12
11.2	13	Unter dem "Submission"-Endpunkt lassen sich Informationen zu eingegangenen Formularen abrufen. Zusätzlich kann ein Bearbeitungsstatus zurückgemeldet werden. Mittels der Mandantennummer und der Formularnummer lässt sich eine Übersicht der eingegangenen Formulare abrufen. Dabei sind nur Metadaten enthalten. Wird beim Assistentenstart eine Ordnungsziffer mitgegeben enthält das Attribut "Payload" die übergebene Ordnungsziffer als eingebettetes JSON Element. Die Anzeige kann eingeschränkt werden, indem als Abfrage-Parameter der gewünschte Status mit angegeben wird. So kann z. B. mittels "?status=NEW" auf neue Anträge eingeschränkt werden. Ebenso ist es möglich mehrere Status gleichzeitig für die Filterung anzugeben. Zusätzlich kann der Abfragezeitraum über die Angabe eines "Last-Modified-Headers" eingeschränkt werden. Dabei handelt es sich um den Zeitpunkt der Einreichung, nicht um den Zeitpunkt der letzten Statusänderung. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation.
1.1	14
6.1	15	## Authentifizierung
1.1	16
12.1	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.
1.1	18
7.1	19	Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
11.1	20	_Mandantennummer:_ 77777777-0000
	21	_API-Schlüssel:_ yIJNM2BS6LI0lS25Qa5xbtEK
1.1	22
11.1	23	> {{icon name="far fa-info-circle" size="3"/}} Hinweis:
	24	>
6.1	25	> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
1.1	26
6.1	27	## Beispielanwendung (Swagger-Dokumentation)
1.1	28
11.1	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>
1.1	30
13.1	31	> _Achtung_ Die oben verlinkte Swagger-Dokumentation greift auf den internen Vertriebs-Server der MACH ProForms GmbH zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/submission/swagger-ui/index.html
9.1	32
6.1	33	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
1.1	34
6.1	35	### Testdaten zu Demonstrationszwecken
3.1	36
11.1	37	_organizationID:_ 77777777-0000
	38	_Identifier:_ KFAS_SubmissionAPI_Test_WithUpload
	39	_transactionID:_ KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb
	40	_messageID:_ 6050a243756f151657af46a4
	41	_fileID:_ 6050a2e8756f151657af46a6
1.1	42
8.1	43	## Anwendungsbeispiele
7.1	44
8.1	45	### Anwendungsbeispiel 1
7.1	46
11.1	47	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.
8.1	48
	49	### Anwendungsbeispiel 2
	50
11.1	51	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.
8.1	52
	53	### Anwendungsbeispiel 3
	54
11.1	55	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.
8.1	56
	57	### Anwendungsbeispiel 4
	58
11.1	59	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.