Änderungen von Dokument Search-API

Zusammenfassung

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

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,15 +1,13 @@
1	1	## Allgemeines
2	2
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.
	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.
6	6
7	7	## Voraussetzungen
8	8
9		-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.
10	10
11		-* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
12		-
13	13	## Verwendung der Schnittstelle
14	14
15	15	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.
...	...	@@ -16,32 +16,32 @@
16	16
17	17	## Einschränkungen
18	18
19		-Im jetzigen Stand der Entwicklung der Schnittstelle ergeben 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.
20	20
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	+## Authentifizierung
22	22
23		-## Suchverhalten
	23	+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.
24	24
25		-Ein Formular muss folgende Kriterien erfüllen, um mit der neuesten Version der Search-API gefunden werden zu können:
	25	+Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
	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.
26	26
27		-* Den Status "Freigegeben" aufweisen
28		-* Eine "Veröffentlichung" muss existieren
29		-* Muss am Datum der Abfrage aktiv sein (falls das Formular ein Enddatum hat, darf dieses nicht in der Vergangenheit liegen)
30		-* Muss von einem der folgenden Mandanten erstellt worden sein:
31		- * dem abfragenden Mandanten
32		- * einem seiner Verlagsmandanten
	31	+## Beispielanwendung (Swagger-Dokumentation)
33	33
34		-## ​Authentifizierung
	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
35	35
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.
	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
37	37
38		-Einen API-Key können Sie beim Betreiber des Formularservers beantragen.
	38	+Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
39	39
40		-## Beispielanwendung (Swagger-Dokumentation)
	40	+### Testdaten zu Demonstrationszwecken
41	41
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.
	42	+***organizationID:*** 77777777-0000
	43	+***leikaID:*** 99102013000000 (Hundesteuer)
	44	+***ozgID:*** (aktuell gibt es noch keine Testmöglichkeit)
43	43
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.
46		-
47		-Für Funktionstests sind gültige Authentifizierungsdaten für den jeweiligen Server erforderlich (Mandantennummer und API-Key).