Wiki-Quellcode von Error-API

Zuletzt geändert von MACH ProForms GmbH am 25.06.2024

version	line-number	content
1.1	1	## Allgemeines
	2
9.2	3	Während des Antragsprozesses kann der Assistent auf einen Fehler laufen, welcher nicht unbedingt erwartet wird. Um die genaue Fehlerursache festzustellen, musste bisher in jedem Fall der Administrator des Formular-Servers kontaktiert werden. Damit dies künftig nicht mehr notwendig ist, stellt MACH ProForms mit der Error-API eine Lösung bereit, mit der sämtliche Fehler, die standardmäßig auf eine Error-URL weitergeleitet werden, auflistet und dem Sachbearbeiter ersichtlich gemacht werden können. 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 ausgegeben. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben.
1.1	4
	5	## Voraussetzungen
	6
7.1	7	Um die Error-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
1.1	8
7.1	9	* Es muss eine "errorUrl" beim Start des Assistenten mitgegeben werden (siehe hierzu [[Rücksprung-URLs\|doc:Main.03_Steuerungsprozess.03_Portalintegration.WebHome]]).
9.2	10	* Auf dem Formular-Server muss das formsolutions-Release in der Version 4.57.0 oder höher installiert sein.
7.1	11	* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
	12
3.1	13	## Verwendung der Schnittstelle
1.1	14
7.1	15	Um die Schnittstelle verwenden zu können, ist es notwendig eine "errorUrl" wie in [[Rücksprung-URLs\|doc:Main.03_Steuerungsprozess.03_Portalintegration.WebHome]] beschrieben beim Assistentenstart zu übergeben. Somit wird in allen Fehlerfällen, bei denen während des Ausfüllens des Assistenten oder bei der Einreichung auf die hinterlegte "errorUrl" weitergeleitet wird, künftig ein Parameter "errorId" an die URL angehängt. Der Wert des neuen Parameters gibt die ID an, mit welcher der Datensatz aus der Schnittstelle ausgelesen werden kann. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation.
1.1	16
4.1	17	Beispiel nach Weiterleitung auf die angehängte "errorUrl":
7.1	18	<https://www.testurl.de?errorId=5f60c6da8110c14fc9cfa508>
1.1	19
3.1	20	## Authentifizierung
1.1	21
9.2	22	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	23
4.1	24	Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
7.1	25	_Mandantennummer:_ 77777777-0000
	26	_API-Schlüssel:_ yIJNM2BS6LI0lS25Qa5xbtEK
2.1	27
7.1	28	> _Hinweis:_
	29	>
	30	> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
	31
3.1	32	## Beispielanwendung (Swagger-Dokumentation)
1.1	33
7.1	34	Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: <https://vertrieb.form-solutions.de/error/api/swagger-ui.html>
1.1	35
11.1	36	> _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 >/error/api/swagger-ui.html
5.1	37
3.1	38	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
1.1	39
3.1	40	### Testdaten zu Demonstrationszwecken
1.1	41
7.1	42	_organizationID:_ 77777777-0000
	43	_errorID:_ 605080efbfcb686c1c23d358