Server-Information-API

Allgemeines

MACH formsolutions stellt eine Schnittstelle zur Verfügung, die es ermöglicht, allgemeine Informationen über den Server und die verfügbaren Schnittstellen auszulesen.

Voraussetzungen

Um die Server-API nutzen zu können, sind folgende Voraussetzungen zu erfüllen:

• Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.

Verwendung der Schnittstelle

Die API wurde nicht für den Browsergebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise Insomnia oder Postman empfohlen.

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 der Swagger-Dokumentation.

Ausgabeformat

Die Schnittstelle gibt Daten im JSON-Format aus.

Authentifizierung

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.

Einen API-Key können Sie beim Betreiber des Formularservers beantragen.

Beispielanwendung (Swagger-Dokumentation)

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.

Die Adresse der Swagger-Anwendung der Server-API lautet  < Formularserveradresse >/server/api/swagger-ui.html
Um die Anwendung aufzurufen, setzen Sie die Adresse des jeweiligen Formularservers ein.

Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).