Änderungen von Dokument Search-API
Zuletzt geändert von MACH ProForms GmbH am 25.06.2024
Von Version 10.3
bearbeitet von MACH ProForms GmbH
am 25.06.2024
am 25.06.2024
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 11.1
bearbeitet von MACH ProForms GmbH
am 25.06.2024
am 25.06.2024
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Inhalt
-
... ... @@ -1,6 +1,6 @@ 1 1 ## Allgemeines 2 2 3 -MACH ProForms stellt eine Schnittstelle zur Verfügung, mit der die Suche angesprochen werden kann. Hierbei sollen alle Suchergebnisse angefragt werden können, welche auch über die Benutzeroberfläche zu erlangen sind. Damit ein solches Verhalten erzielt werden kann, bietet die Schnittstelle mehrere Parametrisierung smöglichkeiten. 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.3 +MACH ProForms stellt eine Schnittstelle zur Verfügung, mit der die Suche angesprochen werden kann. Hierbei sollen alle Suchergebnisse angefragt werden können, welche auch über die Benutzeroberfläche zu erlangen sind. Damit ein solches Verhalten erzielt werden kann, bietet die Schnittstelle mehrere Möglichkeiten der Parametrisierung. 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. 4 4 5 5 ## Voraussetzungen 6 6 ... ... @@ -46,7 +46,7 @@ 46 46 47 47 Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: <https://vertrieb.form-solutions.de/search/api/swagger-ui/index.html> 48 48 49 -> _**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 >/search/api/swagger-ui/index.html49 +> _**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 >/search/api/swagger-ui/index.html 50 50 51 51 Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt. 52 52