Wiki-Quellcode von Release-API
Zuletzt geändert von Form-Solutions GmbH am 27.09.2021
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | ## Allgemeines | ||
| 2 | |||
| 3 | Form-Solutions stellt eine Schnittstelle zur Verfügung, die alle im System hinterlegten Veröffentlichungen ausliest. Diese Veröffentlichungen beinhalten sowohl Assistenten als auch PDF-Formulare. Die Architektur beruht auf dem REST-Standard und ist in der Lage die angefragten Dokumente entweder im JSON-Format oder im CSV-Format auszuliefern. Wie bei allen von Form-Solutions angebotenen Schnittstellen unterliegt auch diese einem Authentifizierungskonzept. Hierbei werden die Zugriffsberechtigungen auf die getätigte Anfrage geprüft und sichergestellt, dass keine Dokumente ausgeliefert werden, auf die der Zugriff verweigert ist. Eine Besonderheit hierbei stellt der Supermandant dar, welcher als übergeordnete Instanz Zugriff auf alle unterliegenden Mandanten hat. Im nachfolgenden Dokument werden die genauen Funktionalitäten im Einzelnen beschrieben. | ||
| 4 | Wir stellen seit dem Release [4.62.0](https://wiki.form-solutions.de/wiki/docwiki/view/Main/13_Release-Notes/) mehrere Versionen der Release-API zur Verfügung. Die ausführliche Dokumentation finden Sie im Rahmen der Swagger-Dokumentation. Den Link hierfür finden Sie am Ende der Seite. | ||
| 5 | Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt? | ||
| 6 | Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt. | ||
| 7 | |||
| 8 | ## Voraussetzungen | ||
| 9 | |||
| 10 | Um die Release-API nutzen zu können sind folgende Voraussetzungen zu erfüllen: | ||
| 11 | - Der Formularserver benötigt mindestens das Release mit der Version 4.46.0 | ||
| 12 | - Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein. | ||
| 13 | |||
| 14 | ## Verwendung der Schnittstelle | ||
| 15 | |||
| 16 | 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 unserer Swagger-Dokumentation. | ||
| 17 | |||
| 18 | ## Einschränkungen | ||
| 19 | |||
| 20 | Im derzeitigen Zustand hat die Schnittstelle folgende Einschränkungen: | ||
| 21 | - Es werden nicht alle möglichen Konfigurationsoptionen angezeigt | ||
| 22 | - Fehlerhafte Konfigurationsfelder werden ausgeblendet | ||
| 23 | |||
| 24 | Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass | ||
| 25 | - der Assistent seine Gültigkeitsperiode bereits begonnen hat | ||
| 26 | - der Assistent seine Gültigkeitsperiode nicht beendet hat | ||
| 27 | |||
| 28 | Für PDF bedeutet das, dass | ||
| 29 | - die aktuelle Formularversion aktiv ist | ||
| 30 | |||
| 31 | Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen. | ||
| 32 | |||
| 33 | ## Ausgabeformate | ||
| 34 | |||
| 35 | Die Schnittstelle unterstützt insgesamt zwei unterschiedliche Ausgabeformate. Standardmäßig wird hier ein Dokument im JSON-Format ausgehändigt, während über einen Parameter im Header der Anfrage die Ausgabe im CSV-Format erzwungen werden kann. | ||
| 36 | |||
| 37 | ### Ausgabe im JSON-Format | ||
| 38 | |||
| 39 | Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format. Hierbei wird eine Ausgabe erzeugt, welche verschiedene Felder beinhaltet. | ||
| 40 | |||
| 41 | ### Ausgabe im CSV-Format | ||
| 42 | |||
| 43 | Mit dem Header-Parameter „accept“ kann die Ausgabe im CSV-Format erzwungen werden. Hierbei sollte der oben erwähnte Parameter wie folgt aufgebaut sein: "accept = text/csv". Auch hier beinhaltet die Ausgabe verschiedene Felder. | ||
| 44 | |||
| 45 | ## Authentifizierung | ||
| 46 | |||
| 47 | 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. | ||
| 48 | |||
| 49 | Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt: | ||
| 50 | ***Mandantennummer:*** 77777777-0000 | ||
| 51 | ***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK | ||
| 52 | |||
| 53 | > {{icon name="far fa-info-circle" size="3"/}} ***Hinweis:*** | ||
| 54 | > Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung. | ||
| 55 | |||
| 56 | ### Authentifizierung als Supermandant | ||
| 57 | |||
| 58 | Bei der Authentifizierung als Supermandant liegen Berechtigungen auf alle im System hinterlegten Benutzer vor. Somit ist es möglich, alle Veröffentlichungen auf dem Formularserver mandantenübergreifend auszulesen. Gleichzeitig bietet die Schnittstelle über einen Parameter die Möglichkeit auch nur die Veröffentlichungen für einen oder mehrere Mandanten auszulesen. Dieses Verhalten wird über den Parameter "organizationId" gesteuert. | ||
| 59 | |||
| 60 | #### Aufruf ohne Parameter "organizationId" | ||
| 61 | |||
| 62 | ***Pfadbeispiel:*** https://<server-name>/release-api/releases | ||
| 63 | ***Beschreibung:*** Wird die Schnittstelle als Supermandant ohne den Parameter "organizationId" aufgerufen, so werden alle Veröffentlichungen aller im Formularserver hinterlegten Mandanten ausgelesen. Dies betrifft sowohl Assistenten als auch PDF-Formulare. | ||
| 64 | |||
| 65 | #### Aufruf mit Parameter "organizationId" | ||
| 66 | |||
| 67 | ***Pfadbeispiel:*** https://<server-name>/release-api/releases?organizationId=12345678-1234 | ||
| 68 | ***Beschreibung:*** Wird die Schnittstelle als Supermandant mit dem Parameter "organizationId" aufgerufen, so werden alle Veröffentlichungen für den in dem Parameter aufgeführten Mandanten ausgelesen. Dies betrifft sowohl Assistenten als auch PDF-Formulare. Zusätzlich zu dieser Funktion können auch mehrere Mandantennummern kommasepariert als Wert des Parameters eingetragen werden. Somit würden alle Veröffentlichungen der angegebenen Mandantennummern ausgelesen werden. | ||
| 69 | |||
| 70 | ### Authentifizierung als einzelner Mandant | ||
| 71 | |||
| 72 | Bei der Authentifizierung als einzelner Mandant liegen Berechtigungen auf alle Veröffentlichungen des eigenen Mandanten vor. Um die Schnittstelle nach einer solchen Authentifizierung nutzen zu können, wird die oben beschriebene Basis-URL sowie der gewünschte Endpunkt verwendet. | ||
| 73 | |||
| 74 | ***Pfadbeispiel:*** https://<server-name>/release-api/releases | ||
| 75 | |||
| 76 | Da wir mit dieser Art der Authentifizierung bereits eindeutig als Mandant identifiziert sind, wird an dieser Stelle keine Filterung der Mandanten über einen gesonderten Parameter benötigt. Mit der Nutzung der oben beschriebenen URL werden nun alle Veröffentlichungen von Assistenten und PDF-Formularen des angemeldeten Mandanten ausgehändigt. | ||
| 77 | |||
| 78 | ## Beispielanwendung (Swagger-Dokumentation) | ||
| 79 | |||
| 80 | Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: https://vertrieb.form-solutions.de/release-api/swagger-ui/index.html | ||
| 81 | |||
| 82 | > ***Achtung*** | ||
| 83 | > 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 >/release-api/swagger-ui/index.html | ||
| 84 | |||
| 85 | Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt. | ||
| 86 | |||
| 87 | ### Testdaten zu Demonstrationszwecken | ||
| 88 | |||
| 89 | ***organizationID:*** 77777777-0000 | ||
| 90 | ***secureID (Assistent):*** 6050847cb2e9650a8ab19c83 | ||
| 91 | ***secureID (PDF):*** zGVrF5v6N8XzH5j7kJN84qtKrM8TA9A |