Änderungen von Dokument Search-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,12 +1,13 @@
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	+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.
	4	+Die Architektur beruht auf dem REST-Standard. Wie bei allen von MACH formsolutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept.
	5	+Die ausgelesenen Ergebnisdaten werden im JSON-Format ausgegeben.
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 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
...	...	@@ -17,7 +17,7 @@
17	17
18	18	Im jetzigen Stand der Entwicklung der Schnittstelle ergeben sich folgende Einschränkungen:
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	+* Die API wurde nicht für den Browsergebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen.
21	21
22	22	## Suchverhalten
23	23
...	...	@@ -30,28 +30,17 @@
30	30	* dem abfragenden Mandanten
31	31	* einem seiner Verlagsmandanten
32	32
33		-## Authentifizierung
	34	+## ​Authentifizierung
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.
	36	+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.
36	36
37		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
38		-_**Mandantennummer:**_ 77777777-0000
39		-_**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK
	38	+Einen API-Key können Sie beim Betreiber des Formularservers beantragen.
40	40
41		-> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
42		->
43		-> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
44		-
45	45	## Beispielanwendung (Swagger-Dokumentation)
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>
	42	+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.
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
	44	+Die Adresse der Swagger-Anwendung der Search-API lautet `< Formularserveradresse >/search/api/swagger-ui.html`
	45	+Um die Anwendung aufzurufen, setzen Sie die Adresse des jeweiligen Formularservers ein.
50	50
51		-Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
52		-
53		-### Testdaten zu Demonstrationszwecken
54		-
55		-_**organizationID:**_ 77777777-0000
56		-_**leikaID:**_ 99102013000000 (Hundesteuer)
57		-_**ozgID:**_ 10160
	47	+Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).