Wiki-Quellcode von Release-API

Zuletzt geändert von MACH formsolutions am 08.04.2026

version	line-number	content
1.1	1	## Allgemeines
	2
30.1	3	MACH formsolutions stellt eine Schnittstelle zur Verfügung, die alle im System hinterlegten Veröffentlichungen ausliest. Diese Veröffentlichungen beinhalten sowohl Assistenten als auch PDF-Formulare.
	4	Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern.
	5	Wie bei allen von MACH formsolutions 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.
1.1	6
	7	## Voraussetzungen
	8
25.1	9	Um die Release-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
1.1	10
25.1	11	* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
	12
20.1	13	## Verwendung der Schnittstelle
1.1	14
30.1	15	Die API wurde nicht für den Browsergebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise [Insomnia](https://insomnia.rest/) oder [Postman](https://www.postman.com/) empfohlen.
	16
20.1	17	Da die Schnittstelle auf dem REST-Standard beruht, kann diese über eine URL erreicht werden. Hierbei gibt es einen festen Basispfad und einen entsprechenden Endpunkt. Der Basispfad ist bei jedem Aufruf gleich, wobei sich die Endpunkte je nach Funktion unterscheiden können. Ein Endpunkt spricht eine Funktionalität der Schnittstelle an. Da der Basispfad immer gleich ist, können über diverse Endpunkte mehrere Funktionalitäten in die Schnittstelle verbaut werden. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation.
1.1	18
20.1	19	## Einschränkungen
1.1	20
27.1	21	Zur Zeit gelten für die Schnittstelle folgende Einschränkungen:
1.1	22
25.1	23	* Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
	24	* Fehlerhafte Konfigurationsfelder werden ausgeblendet
1.1	25
25.1	26	Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass
1.1	27
25.2	28	* die Gültigkeitsperiode für den Assistenten bereits begonnen hat
	29	* die Gültigkeitsperiode des Assistenten noch nicht beendet ist
25.1	30
	31	Für PDF bedeutet das, dass
	32
	33	* die aktuelle Formularversion aktiv ist
	34
20.1	35	## Ausgabeformate
1.1	36
30.1	37	### Ausgabe im JSON-Format (Standard)
1.1	38
30.1	39	Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format.
1.1	40
20.1	41	### Ausgabe im CSV-Format
1.1	42
30.1	43	Mit dem Header-Parameter "accept = text/csv" kann die Ausgabe im CSV-Format erfolgen.
1.1	44
20.1	45	## Authentifizierung
1.1	46
30.1	47	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.
1.1	48
30.1	49	Einen API-Key können Sie beim Betreiber des Formularservers beantragen.
17.1	50
20.1	51	### Authentifizierung als Supermandant
17.1	52
30.1	53	Bei der Authentifizierung als Supermandant liegen Berechtigungen auf alle im System hinterlegten Mandanten vor. Somit ist es möglich, alle Veröffentlichungen auf dem Formularserver mandantenübergreifend auszulesen. Gleichzeitig bietet die Schnittstelle über den Parameter "organizationId" die Möglichkeit, jeweils nur die Veröffentlichungen für einen oder mehrere Mandanten auszulesen.
17.1	54
20.1	55	### Authentifizierung als einzelner Mandant
1.1	56
30.1	57	Bei der Authentifizierung als einzelner Mandant liegen Berechtigungen auf alle Veröffentlichungen des eigenen Mandanten vor. Es werden die Veröffentlichungen von Assistenten und PDF-Formularen des authentifizierten Mandanten übergeben.
1.1	58
20.1	59	## Beispielanwendung (Swagger-Dokumentation)
1.1	60
30.1	61	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.
1.1	62
30.1	63	Die Adresse der Swagger-Anwendung der Release-API lautet `< Formularserveradresse >/release-api/swagger-ui/index.html`
	64	Um die Anwendung aufzurufen, setzen Sie die Adresse des jeweiligen Formularservers ein.
23.1	65
30.1	66	Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).