Wiki-Quellcode von Search-API
Zuletzt geändert von MACH ProForms GmbH am 25.06.2024
Verstecke letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | ## Allgemeines |
| 2 | |||
| |
10.4 | 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 Möglichkeiten der Parametrisierung. 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. |
| |
1.1 | 4 | |
| 5 | ## Voraussetzungen | ||
| 6 | |||
| |
8.1 | 7 | Um die Search-API nutzen zu können sind folgende Voraussetzungen zu erfüllen: |
| |
1.1 | 8 | |
| |
10.2 | 9 | * Der Formular-Server benötigt mindestens das Release mit der Version 4.51.0. |
| |
8.1 | 10 | * Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein. |
| 11 | |||
| |
3.1 | 12 | ## Verwendung der Schnittstelle |
| |
1.1 | 13 | |
| |
3.1 | 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. |
| |
1.1 | 15 | |
| |
3.1 | 16 | ## Einschränkungen |
| |
1.1 | 17 | |
| |
10.2 | 18 | Im jetzigen Stand der Entwicklung der Schnittstelle ergeben sich folgende Einschränkungen: |
| |
1.1 | 19 | |
| |
8.1 | 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 | ||
| |
9.1 | 27 | * Eine "Veröffentlichung" muss existieren |
| |
8.1 | 28 | * Muss am Datum der Abfrage aktiv sein (falls das Formular ein Enddatum hat, darf dieses nicht in der Vergangenheit liegen) |
| |
10.2 | 29 | * Muss von einem der folgenden Mandanten erstellt worden sein: |
| 30 | * dem abfragenden Mandanten | ||
| 31 | * einem seiner Verlagsmandanten | ||
| |
8.1 | 32 | |
| |
3.1 | 33 | ## Authentifizierung |
| |
1.1 | 34 | |
| |
10.2 | 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. |
| |
1.1 | 36 | |
| |
4.1 | 37 | Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt: |
| |
8.1 | 38 | _**Mandantennummer:**_ 77777777-0000 |
| 39 | _**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK | ||
| |
1.1 | 40 | |
| |
8.1 | 41 | > {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_ |
| 42 | > | ||
| 43 | > Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung. | ||
| 44 | |||
| |
3.1 | 45 | ## Beispielanwendung (Swagger-Dokumentation) |
| |
1.1 | 46 | |
| |
8.1 | 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> |
| |
1.1 | 48 | |
| |
11.1 | 49 | > _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den internen Vertriebs-Server 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 |
| |
5.1 | 50 | |
| |
3.1 | 51 | Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt. |
| |
1.1 | 52 | |
| |
3.1 | 53 | ### Testdaten zu Demonstrationszwecken |
| |
1.1 | 54 | |
| |
8.1 | 55 | _**organizationID:**_ 77777777-0000 |
| 56 | _**leikaID:**_ 99102013000000 (Hundesteuer) | ||
| 57 | _**ozgID:**_ 10160 |