Search-API

Allgemeines

MACH formsolutions stellt eine Schnittstelle zur Verfügung, mit der die Suche angesprochen werden kann. Hier können alle Suchergebnisse angefragt werden, welche auch über die Benutzeroberfläche zu erlangen sind.
Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH formsolutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept.
Die ausgelesenen Ergebnisdaten werden im JSON-Format ausgegeben.

Voraussetzungen

Um die Search-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

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. Damit die Suchlogik abgebildet und somit die Suchergebnisse gefiltert werden können, bietet die Schnittstelle einige Parameter an, die als Query-Parameter an die URL angefügt werden können. Weitere Verwendungsmöglichkeiten finden Sie in unserer Swagger-Dokumentation.

Einschränkungen

Im jetzigen Stand der Entwicklung der Schnittstelle ergeben sich folgende Einschränkungen:

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

Suchverhalten

Ein Formular muss folgende Kriterien erfüllen, um mit der neuesten Version der Search-API gefunden werden zu können:

• Den Status "Freigegeben" aufweisen
• Eine "Veröffentlichung" muss existieren
• Muss am Datum der Abfrage aktiv sein (falls das Formular ein Enddatum hat, darf dieses nicht in der Vergangenheit liegen)
• Muss von einem der folgenden Mandanten erstellt worden sein:
  • dem abfragenden Mandanten
  • einem seiner Verlagsmandanten

​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 Search-API lautet < Formularserveradresse >/search/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).