Änderungen von Dokument Release-API

Zuletzt geändert von MACH ProForms GmbH am 25.06.2024

Von 18.1 nach 17.1 Von 25.2 nach 25.1

Von Version 25.1

bearbeitet von MACH ProForms GmbH
am 24.06.2024

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Auf Version 18.1

bearbeitet von MACH ProForms GmbH
am 15.02.2021

Änderungskommentar: Es gibt keinen Kommentar für diese Version

Rohform
Im Layout

Zusammenfassung

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

Details

Seiteneigenschaften

Dokument-Autor

@@ -1,1 +1,1 @@
--xwiki:XWiki.fweise
++xwiki:XWiki.Dokumentation

Inhalt

@@ -1,92 +1,189 @@
  ## Allgemeines
--MACH ProForms 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 MACH ProForms 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. 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. Was wird durch die Version 3 der Release-API neu zur Verfügung gestellt? Es werden nun zusätzlich zu der Leika-ID auch die OZG-ID's in der Response der Schnittstelle bereitgestellt.
++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.
++___
++
  ## Voraussetzungen
  Um die Release-API nutzen zu können sind folgende Voraussetzungen zu erfüllen:
--* Der Formularserver benötigt mindestens das Release mit der Version 4.46.0
--* Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
++- Der Formularserver benötigt mindestens das [Release](https://wiki.form-solutions.de/wiki/docwiki/view/Main/13_Release-Notes/) mit der Version 4.46.0
++- Es muss für die Authentifizierung die Mandantennummer und der API-Key vorhanden sein.
--## Verwendung der Schnittstelle
++___
--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.
--## Einschränkungen
++## Verwenden der Schnittstelle
--Im derzeitigen Zustand hat die Schnittstelle folgende Einschränkungen:
++### Einstiegspunkt
--* Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
--* Fehlerhafte Konfigurationsfelder werden ausgeblendet
++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.
--Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass
++```javascript
++Basispfad:
++https://<server-name>/release-api
++```
--* der Assistent seine Gültigkeitsperiode bereits begonnen hat
--* der Assistent seine Gültigkeitsperiode nicht beendet hat
++#### Endpunkte
--Für PDF bedeutet das, dass
++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.
++Im Folgenden wird eine Auflistung aller aktuell unterstützten Endpunkte aufgeführt.
--* die aktuelle Formularversion aktiv ist
++```javascript
++Endpunkt: /releases
--Die API wurde nicht für den Browser gebrauch konzipiert. Um die Anbindung zu testen, werden externe Tools wie beispielsweise "Insomnia" oder "Postman" empfohlen.
++Pfadbeispiel:
++    https://<server-name>/release-api/releases
++```
--## Ausgabeformate
++_Beschreibung: Der hier aufgeführte Endpunkt liefert alle Veröffentlichungen eines Mandanten (sowohl Assistenten als auch PDF-Formulare) zurück. Hierbei besteht die Möglichkeit sich als einzelner Mandant oder als Supermandant anzumelden. Die detaillierte Unterscheidung dieser beiden Methoden findet sich unter dem Punkt Authentifizierung._
--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.
++```javascript
++Endpunkt: /releases/assistants
--### Ausgabe im JSON-Format
++Pfadbeispiel:
++    https://<server-name>/release-api/releases/assistants
++```
--Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format. Hierbei wird eine Ausgabe erzeugt, welche verschiedene Felder beinhaltet.
++_Beschreibung: Der hier aufgeführte Endpunkt liefert alle Veröffentlichungen von Assistenten eines Mandanten zurück. Hierbei besteht die Möglichkeit sich als einzelner Mandant oder als Supermandant anzumelden. Die detaillierte Unterscheidung dieser beiden Methoden findet sich unter dem Punkt Authentifizierung._
--### Ausgabe im CSV-Format
++```javascript
++Endpunkt: /releases/pdfs
--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.
++Pfadbeispiel:
++    https://<server-name>/release-api/releases/pdfs
++```
--## Authentifizierung
++_Beschreibung: Der hier aufgeführte Endpunkt liefert alle Veröffentlichungen von PDF-Formularen eines Mandanten zurück. Hierbei besteht die Möglichkeit sich als einzelner Mandant oder als Supermandant anzumelden. Die detaillierte Unterscheidung dieser beiden Methoden findet sich unter dem Punkt Authentifizierung._
--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.
++```javascript
++Endpunkt: /releases/secureIds
--Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
--_**Mandantennummer:**_ 77777777-0000
--_**API-Schlüssel:**_ yIJNM2BS6LI0lS25Qa5xbtEK
++Pfadbeispiele:
++    https://<server-name>/release-api/releases/secureIds
++    https://<server-name>/release-api/releases/assistants/secureIds
++    https://<server-name>/release-api/releases/pdfs/secureIds
++```
--> {{icon name="far fa-info-circle" size="3"/}} _**Hinweis:**_
-->
--> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
++_Beschreibung: Der hier aufgeführte Endpunkt liefert ausschließlich alle "SecureId's" der angefragten Veröffentlichungen zurück. Eine SecureId dient zur eindeutigen Idenfizierung einer Veröffentlichung. Hierbei besteht die Möglichkeit sich als einzelner Mandant oder als Supermandant anzumelden. Die detaillierte Unterscheidung dieser beiden Methoden findet sich unter dem Punkt Authentifizierung._
--### Authentifizierung als Supermandant
++![[Anzeige der SecureID|@Release-API-SecureID.jpg]]
--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.
++### Authentifizierung
--#### Aufruf ohne Parameter "organizationId"
++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 Formularservers beantragt werden.
++Generell werden die beiden im Folgenden aufgeführten Authentifizierungsarten unterschieden.
--_**Pfadbeispiel:**_ <https://>/release-api/releases
--_**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.
++Mit dem folgenden Link wird auf eine Oberfläche weitergeleitet, bei der die Schnittstelle auf ihre Funktionalität getestet werden kann.
++Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
--#### Aufruf mit Parameter "organizationId"
++*Beispiel: [https://vertrieb.form-solutions.de/release-api/swagger-ui.html](https://vertrieb.form-solutions.de/release-api/swagger-ui.html)*
++<br>
++*Mandantennummer: 88888888-8888*
++<br>
++*API-Schlüssel: npcnqwpefwAFWFAFAFqwcqcqwc23rf23rzhbnerg*
--_**Pfadbeispiel:**_ <https://>/release-api/releases?organizationId=12345678-1234
--_**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.
--### Authentifizierung als einzelner Mandant
--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.
++> ***Hinweis:***
++> Die verwendete Authentifizierungsart ist eine [Basis-Authentifizierung](https://de.wikipedia.org/wiki/HTTP-Authentifizierung#Basic_Authentication).
--_**Pfadbeispiel:**_ <https://>/release-api/releases
++#### Authentifizierung als Supermandant
++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.
++
++**Aufruf ohne Parameter \organizationId\**
++
++```javascript
++Pfadbeispiel: https://<server-name>/release-api/releases
++```
++
++_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._
++
++
++**Aufruf mit Parameter \organizationId\**
++
++```javascript
++Pfadbeispiel: https://<server-name>/release-api/releases?organizationId=12345678-1234
++```
++
++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.
++
++#### Authentifizierung als einzelner Mandant
++
++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.
++
++```javascript
++Pfadbeispiel: https://<server-name>/release-api/releases
++```
++
  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.
--## Beispielanwendung (Swagger-Dokumentation)
++___
--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>
++## Parameter
--> _**Achtung**_ Die oben verlinkte Swagger-Dokumentation greift auf den MACH ProForms internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/release-api/swagger-ui/index.html
++Über die nachfolgenden Parameter kann die Schnittstelle entsprechende Filterungen der Suchanfragen vornehmen. Diese werden hierbei als Query-Parameter übergeben.
--Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
++> **organizationId**
--### Testdaten zu Demonstrationszwecken
++*Beschreibung: Durch diesen Parameter kann gesteuert werden, welche Mandanten von der Suchanfrage betroffen sind. Liegen keine Berechtigungen auf die angegebenen Mandantennummern vor, so werden diese nicht bei der Suche berücksichtigt. Es können mehrere Mandantennummern kommasepariert eingegeben werden.*
--_**organizationID:**_ 77777777-0000
--_**secureID (Assistent):**_ 6050847cb2e9650a8ab19c83
--_**secureID (PDF):**_ zGVrF5v6N8XzH5j7kJN84qtKrM8TA9A
++```javascript
++Pfadbeispiel: https://<server-name>/release-api/releases?organizationId=12345678-1234
++```
++
++> **secureId**
++
++*Beschreibung: Durch diesen Parameter können einzelne Veröffentlichungen mit den angegebenen secureId's an allen Endpunkten ermittelt werden. Die Werte können kommasepariert eingegeben werden.*
++
++```javascript
++Pfadbeispiel: https://<server-name>/release-api/releases?secureId=5b9b53dad5de93019b42df8c
++```
++
++### Ausgabeformate
++
++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.
++
++#### Ausgabe im JSON-Format
++
++Werden keine Header-Parameter mitgegeben, erfolgt die Ausgabe standardmäßig im JSON-Format. Hierbei wird eine Ausgabe erzeugt, welche verschiedene Felder beinhaltet. Welche Bedeutung diese Felder haben und wie eine Beispielausgabe aussehen kann, wir [[hier|Main.02_FSSchnittstellen.02_ReleaseAPI.01_Ressourcen.01_JSON]] beschrieben.
++
++#### Ausgabe im CSV-Format
++
++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, der Bedeutung inklusive einem Ausgabebeispiel [[hier|Main.02_FSSchnittstellen.02_ReleaseAPI.01_Ressourcen.02_CSV]] nachgelesen werden kann.
++
++___
++
++## Einschränkungen
++
++Im derzeitigen Zustand hat die Schnittstelle folgende Einschränkungen:
++- Es werden nicht alle möglichen Konfigurationsoptionen angezeigt
++- Fehlerhafte Konfigurationsfelder werden ausgeblendet
++
++Weiterhin werden nur "gültige" Veröffentlichungen angezeigt. Für Assistenten bedeutet das, dass
++
++- der Assistent seine Gültigkeitsperiode bereits begonnen hat
++- der Assistent seine Gültigkeitsperiode nicht beendet hat
++
++Für PDF bedeutet das, dass
++- die aktuelle Formularversion aktiv ist
++
++
++Zudem ist die Schnittstelle nicht zur Verwendung mit Browsern gedacht. Es werden daher keine Garantien über die vollständige Kompatibilität der Schnittstelle mit Browsern gemacht. Die browsergestützte Verwendung erfolgt auf eigene Gefahr.
++Um die Schnittstelle verwenden zu können, kann diese entweder programmatisch oder über entsprechende Hilfsprogramme (Insomnia, Postman, ...) angesprochen werden.
++___
++
++## Beispielanwendung
++
++Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: https://vertrieb.form-solutions.de/release-api/swagger-ui.html
++
++Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation bereit, welche die einzelnen Ressourcen detaillierter beschreibt.
++
++
++
++
++