Änderungen von Dokument Search-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,57 +1,103 @@
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 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.
	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 im Folgenden genauer beschrieben werden.
4	4
	5	+Wie bei allen von Form-Solutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept, welches anhand einer Demoanwendung ebenfalls in der Dokumentation aufgegriffen wird.
	6	+Die ausgelesenen Ergebnisdaten werden im JSON-Format zurückgeliefert.
	7	+
	8	+___
	9	+
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 Formular-Server 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.
	14	+- Der Formularserver benötigt mindestens das [Release](https://wiki.form-solutions.de/wiki/docwiki/view/Main/13_Release-Notes/) mit der Version 4.51.0
	15	+- Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
11	11
12		-## Verwendung der Schnittstelle
	17	+___
13	13
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.
	19	+## Verwenden der Schnittstelle
15	15
16		-## Einschränkungen
	21	+### Einstiegspunkt
17	17
18		-Im jetzigen Stand der Entwicklung der Schnittstelle ergeben sich folgende Einschränkungen:
	23	+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.
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.
	25	+```javascript
	26	+Basispfad:
	27	+https://<server-name>/search/api
	28	+```
21	21
22		-## Suchverhalten
	30	+#### Endpunkte
23	23
24		-Ein Formular muss folgende Kriterien erfüllen, um mit der neuesten Version der Search-API gefunden werden zu können:
	32	+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. Im Folgenden wird eine Auflistung aller aktuell unterstützten Endpunkte aufgeführt.
25	25
26		-* Den Status "Freigegeben" aufweisen
27		-* Eine "Veröffentlichung" muss existieren
28		-* Muss am Datum der Abfrage aktiv sein (falls das Formular ein Enddatum hat, darf dieses nicht in der Vergangenheit liegen)
29		-* Muss von einem der folgenden Mandanten erstellt worden sein:
30		- * dem abfragenden Mandanten
31		- * einem seiner Verlagsmandanten
	34	+```javascript
	35	+Endpunkt: /forms
32	32
33		-## Authentifizierung
	37	+Pfadbeispiel: https://<server-name>/search/api/forms
	38	+```
34	34
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.
	40	+*Beschreibung: Unter diesem Endpunkt können alle Assistenten und PDF's, auf welche die entsprechenden Zugriffsberechtigungen für den angemeldeten Benutzer vorliegen, abgefragt werden.*
36	36
37		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
38		-_**Mandantennummer:**_ 77777777-0000
39		-_**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK
	42	+```javascript
	43	+Endpunkt: /forms/assistants
40	40
41		-> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
42		->
43		-> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
	45	+Pfadbeispiel: https://<server-name>/search/api/forms/assistants
	46	+```
44	44
45		-## Beispielanwendung (Swagger-Dokumentation)
	48	+*Beschreibung: Unter diesem Endpunkt können alle Assistenten, auf welche die entsprechenden Zugriffsberechtigungen für den angemeldeten Benutzer vorliegen, abgefragt werden.*
46	46
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>
	50	+```javascript
	51	+Endpunkt: /forms/pdfs
48	48
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
	53	+Pfadbeispiel: https://<server-name>/search/api/forms/pdfs
	54	+```
50	50
51		-Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
	56	+*Beschreibung: Unter diesem Endpunkt können alle PDF's, auf welche die entsprechenden Zugriffsberechtigungen für den angemeldeten Benutzer vorliegen, abgefragt werden.*
52	52
53		-### Testdaten zu Demonstrationszwecken
	58	+#### Parameter
54	54
55		-_**organizationID:**_ 77777777-0000
56		-_**leikaID:**_ 99102013000000 (Hundesteuer)
57		-_**ozgID:**_ 10160
	60	+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.
	61	+
	62	+- **organizationId**
	63	+Beschreibung: Dieser Parameter filtert die Suchergebnisse auf einen speziellen Mandanten. Ist der Zugriff auf die angegebene Mandantenummer nicht erlaubt, so wird ein leeres JSON-Dokument zurückgeliefert.
	64	+
	65	+- **leikaId**
	66	+Beschreibung: Dieser Parameter filter die Suchergebnisse auf eine oder mehrere LeiKa-ID's. Diese können kommasepariert eingetragen werden. Hierbei werden alle Assistenten und/oder PDFs im JSON Format zurückgeliefert, welche die gefilterten LeiKa-ID's beinhalten.
	67	+
	68	+ ```javascript
	69	+ Beispiel: https://<server-name>/search/api/forms/pdfs?organizationId=22222222-2222&leikaId=12341234123412
	70	+ ```
	71	+ *Beschreibung: Mit diesem Beispiel werden alle PDF's für die Mandantennumer 22222222-2222 und der LeikaId 12341234123412 abgerufen, auf die der Zugriff anhand der Authentifizierung erlaubt ist.*
	72	+
	73	+**Hinweis:** Alle Parameter können gemeinsam bei jedem der oben genannten Endpunkte verwendet werden. In diesem Falle werden beim Filtern der Suchergebnisse alle angegebenen Parameter berücksichtigt.
	74	+
	75	+### Authentifizierung
	76	+
	77	+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.
	78	+
	79	+Mit dem folgenden Link wird auf eine Oberfläche weitergeleitet, bei der die Schnittstelle auf ihre Funktionalität getestet werden kann.
	80	+Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
	81	+
	82	+*Beispiel: [https://vertrieb.form-solutions.de/search/api/swagger-ui.html](https://vertrieb.form-solutions.de/search/api/swagger-ui.html)*
	83	+<br>
	84	+*Mandantennummer: 88888888-8888*
	85	+<br>
	86	+*API-Schlüssel: npcnqwpefwAFWFAFAFqwcqcqwc23rf23rzhbnerg*
	87	+
	88	+> ***Hinweis:***
	89	+> Die verwendete Authentifizierungsart ist eine [Basis-Authentifizierung](https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication).
	90	+
	91	+### Ausgabeformat
	92	+
	93	+Die Schnittstelle liefert ihre Daten im Standardformat JSON zurück. Der detaillierte Aufbau und die Bedeutung der einzelnen Felder können [[hier|Main.02_FSSchnittstellen.03_SearchAPI.01_Resources]] entnommen werden.
	94	+
	95	+### Einschränkungen
	96	+
	97	+Im jetzigen Zustand der Schnittstelle bilden sich folgende Einschränkungen:
	98	+
	99	+- Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise *Insomnia* oder *Postman* empfohlen.
	100	+
	101	+- 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.
	102	+
	103	+