Änderungen von Dokument Search-API

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-xwiki:XWiki.fweise
	1	+xwiki:XWiki.Dokumentation

Inhalt

...	...	@@ -1,12 +1,12 @@
1	1	## Allgemeines
2	2
3		-Form-Solutions 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 Parametrisierungsmöglichkeiten. Die Architektur beruht auf dem REST-Standard. Wie bei allen von Form-Solutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert. 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 Parametrisierungsmö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.
4	4
5	5	## Voraussetzungen
6	6
7	7	Um die Search-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
8	8
9		-* Der Formularserver benötigt mindestens das Release mit der Version 4.51.0.
	9	+* Der Formular-Server benötigt mindestens das Release mit der Version 4.51.0.
10	10	* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
11	11
12	12	## Verwendung der Schnittstelle
...	...	@@ -15,7 +15,7 @@
15	15
16	16	## Einschränkungen
17	17
18		-Im jetzigen Zustand der Schnittstelle bilden sich folgende Einschränkungen:
	18	+Im jetzigen Stand der Entwicklung der Schnittstelle ergeben sich folgende Einschränkungen:
19	19
20	20	* Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen.
21	21
...	...	@@ -24,12 +24,15 @@
24	24	Ein Formular muss folgende Kriterien erfüllen, um mit der neuesten Version der Search-API gefunden werden zu können:
25	25
26	26	* Den Status "Freigegeben" aufweisen
	27	+* Eine "Veröffentlichung" muss existieren
27	27	* Muss am Datum der Abfrage aktiv sein (falls das Formular ein Enddatum hat, darf dieses nicht in der Vergangenheit liegen)
28		-* Muss von einem der folgenden Mandanten erstellt worden sein: Dem abfragenden Mandanten oder einem seiner Verlagsmandanten
	29	+* Muss von einem der folgenden Mandanten erstellt worden sein:
	30	+ * dem abfragenden Mandanten
	31	+ * einem seiner Verlagsmandanten
29	29
30	30	## Authentifizierung
31	31
32		-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 Fomularservers beantragt werden.
	35	+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.
33	33
34	34	Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
35	35	_**Mandantennummer:**_ 77777777-0000
...	...	@@ -43,7 +43,7 @@
43	43
44	44	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>
45	45
46		-> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den Form-Solutions internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/search/api/swagger-ui/index.html
	49	+> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den internen Vertriebsserver 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
47	47
48	48	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
49	49