Ä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

...	...	@@ -4,11 +4,10 @@
4	4
5	5	## Voraussetzungen
6	6
7		-Um die Search-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
	7	+Um die Search-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
	8	+- Der Formularserver benötigt mindestens das Release mit der Version 4.51.0.
	9	+- Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
8	8
9		-* Der Formularserver benötigt mindestens das Release mit der Version 4.51.0.
10		-* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
11		-
12	12	## Verwendung der Schnittstelle
13	13
14	14	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.
...	...	@@ -15,40 +15,32 @@
15	15
16	16	## Einschränkungen
17	17
18		-Im jetzigen Zustand der Schnittstelle bilden sich folgende Einschränkungen:
	17	+Im jetzigen Zustand der Schnittstelle bilden sich folgende Einschränkungen:
	18	+- Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen.
	19	+- Die API bildet Stand heute noch nicht alle Funktionalitäten der Suche aus der Oberfläche ab. Diese sollen nach und nach sukzessive eingebunden werden.
19	19
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		-
22		-## Suchverhalten
23		-
24		-Ein Formular muss folgende Kriterien erfüllen, um mit der neuesten Version der Search-API gefunden werden zu können:
25		-
26		-* Den Status "Freigegeben" aufweisen
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		-
30	30	## Authentifizierung
31	31
32	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.
33	33
34	34	Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
35		-_**Mandantennummer:**_ 77777777-0000
36		-_**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK
	26	+***Mandantennummer:*** 77777777-0000
	27	+***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
	28	+> {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:***
	29	+> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
37	37
38		-> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
39		->
40		-> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
41		-
42	42	## Beispielanwendung (Swagger-Dokumentation)
43	43
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>
	33	+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
	35	+> ***Achtung***
	36	+> 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
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
50	50	### Testdaten zu Demonstrationszwecken
51	51
52		-_**organizationID:**_ 77777777-0000
53		-_**leikaID:**_ 99102013000000 (Hundesteuer)
54		-_**ozgID:**_ 10160
	42	+***organizationID:*** 77777777-0000
	43	+***leikaID:*** 99102013000000 (Hundesteuer)
	44	+***ozgID:*** 10160
	45	+