Wiki-Quellcode von Server-Information-API
Zuletzt geändert von Form-Solutions GmbH am 16.02.2022
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | ## Allgemeines | ||
| 2 | |||
| 3 | Form-Solutions stellt eine Schnittstelle zur Verfügung, die es ermöglicht, allgemeine Informationen über den Server und die verfügbaren Schnittstellen auszulesen. | ||
| 4 | |||
| 5 | ## Voraussetzungen | ||
| 6 | |||
| 7 | Um die Server-API nutzen zu können sind folgende Voraussetzungen zu erfüllen: | ||
| 8 | |||
| 9 | - Der Formularserver benötigt mindestens das Release mit der Version 4.73.0 | ||
| 10 | - Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein. | ||
| 11 | |||
| 12 | ## Verwendung der Schnittstelle | ||
| 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. Weitere Verwendungsmöglichkeiten finden Sie in der entsprechenden [Swagger-Dokumentation](https://vertrieb.form-solutions.de/server/api/swagger-ui.html) | ||
| 15 | |||
| 16 | ## Einschränkungen | ||
| 17 | |||
| 18 | Die API wurde nicht für den Browser Gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise [Insomnia](https://insomnia.rest/) oder [Postman](https://www.postman.com/) empfohlen. | ||
| 19 | |||
| 20 | ## Ausgabeformate | ||
| 21 | |||
| 22 | Die Schnittstelle gibt Daten im JSON-Format aus. | ||
| 23 | |||
| 24 | ## Authentifizierung | ||
| 25 | |||
| 26 | 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, | ||
| 27 | kann dieser beim Administrator des Fomularservers beantragt werden. | ||
| 28 | |||
| 29 | Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt: | ||
| 30 | |||
| 31 | - ***Mandantennummer:*** 77777777-0000 | ||
| 32 | - ***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK | ||
| 33 | |||
| 34 | > {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:*** | ||
| 35 | > Die Authentifizierung ist nur mit HTTP-Basic möglich. | ||
| 36 | |||
| 37 | ## Beispielanwendung (Swagger-Dokumentation) | ||
| 38 | |||
| 39 | Um die Schnittstelle beispielhaft bedienen zu können, wird eine [Demoanwendung](https://vertrieb.form-solutions.de/server/api/swagger-ui.html) bereitgestellt. | ||
| 40 | |||
| 41 | > ***Achtung*** | ||
| 42 | > 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: | ||
| 43 | > `< BASIS_URL >/server/api/swagger-ui.html` | ||
| 44 | |||
| 45 | Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt. |