Digital-Access-APIs ermöglichen einem Drittanbietersystem die Integration in das Evolve Workflow-System. Diese APIs werden mit dem API-Gateway und seinem unterstützten Authentifizierungsmechanismus gesichert.
Voraussetzungen
Für die Verwendung der Digital-Access-API gelten folgende Voraussetzungen:
-
Die Digital-Access-Lizenz für Prozesse muss im Evolve System aktiviert sein.
-
Der Wert des Schlüssels ProcessExtensionEnable sollte auf Wahr gesetzt sein.
Der Administrator kann diese Funktion vorübergehend über „Anwendungssystem“ → „Infrastruktur“ → „Erweiterte Einstellungen“ deaktivieren. Diese Funktion kann durch Entfernen des Schlüssels ProcessExtensionEnable deaktiviert werden. Sie kann wieder aktiviert werden, indem die Kategorie „System“ hinzugefügt wird und der Wert des Schlüssels „ProcessExtensionEnable“ auf „Wahr“ gesetzt wird.
API für eine Composer Lösung aktivieren/deaktivieren
Standardmäßig sind sämtliche Lösungen, d. h. die Excel-Lösungen und Formularlösungen, für den Zugriff über die API aktiviert. Sobald eine Lizenz aktiviert ist, sind daher alle vorhandenen Lösungen über die API zugänglich. Eine Lösung kann ausdrücklich von der API ausgeschlossen werden, wodurch der Zugriff über die API auf eine bestimmte Lösung eingeschränkt wird. Das bedeutet, dass für ausgeschlossene Lösungen kein Prozess gestartet oder keine Aufgabe abgeschlossen werden kann. Wählen Sie hierzu die Lösung aus, und ändern Sie im Lösungsraster die API-Eigenschaften dieser Lösung. Nur der App-Administrator oder der Lösungsentwickler kann die Schaltfläche API-Eigenschaften anzeigen und den Wert für diese Eigenschaft ändern.
API-Nutzungsdetails für eine Composer Lösung
Der Benutzer kann die API-Nutzung für eine Lösung überprüfen, indem er die Lösung auswählt und in den Optionen auf die Schaltfläche API-Nutzung klickt. Bei einer Formularlösung kann der App-Administrator die Nutzung sowohl für Query als auch für Transaction anzeigen. Bei einer Excel-Lösung kann der App-Administrator nur die Nutzung für Transaction anzeigen.
Nutzlastgenerierung
Benutzer können aus dem Lösungsraster die Nutzlast für „Formularlösung“ und „Excel-Lösung“ herunterladen. Um die Nutzlast für eine Formularlösung im JSON-Format herunterzuladen, klicken Sie auf die Schaltfläche JSON-Nutzlast, und um die Nutzlast im XML-Format herunterzuladen, klicken Sie auf die Schaltfläche XML-Nutzlast. Bei einer Excel-Lösung kann der Benutzer die Nutzlast nur im JSON-Format herunterladen. Um die Nutzlast herunterzuladen, wählen Sie im Lösungsraster die Lösung aus, und klicken Sie auf die Schaltfläche Nutzlast.
- Beim Herunterladen der XML\JSON-Nutzlast für eine Formularlösung muss mindestens einmal ein Formular bereitgestellt werden. Die heruntergeladene XML\JSON-Nutzlast entspricht der neuesten Version des bereitgestellten Formulars.
- Die XML\JSON-Nutzlast enthält alle Standardwerte, die auf dem Formular für normale oder wiederholte Felder bereitgestellt werden.
- Verwenden Sie die getDocument-API, um die aktuelle XML\JSON-Nutzlast für die laufenden Prozesse herunterzuladen: „<URL der Evolve Website>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/XML“ oder „<URL der Evolve Website>/svr/api/v1/Processextn/GetDocumentDataByProcess/Form/{Process-Id}/JSON“
- Die oben erwähnte API gibt die XML\JSON-Nutzlast mit Standardwerten oder bereitgestellten Werten für den laufenden Prozess zurück.
- Wenn der Benutzer beim Herunterladen der JSON-Nutzlast ein globaler Administrator oder App Administrator ist, wird der Parameter AppName der heruntergeladenen JSON-Nutzlast hinzugefügt. Wenn der Benutzer kein Administrator ist, muss der Benutzer den Parameter AppName nach dem Herunterladen der Nutzlast manuell hinzufügen.
Für die Evolve URL muss der Benutzer die Portnummer angeben, es sei denn, es handelt sich nicht um die Standardportnummer. Wenn wir beispielsweise eine Evolve Website am Standardport 80 haben, können wir beide der folgenden Evolve URLs für den Zugriff auf die API verwenden.
-
http://cha-de-vstpnx1.wsdt.local:80/svr/api/v1/Processextn/GetAllAssignments
-
http://cha-de-vstpnx1.wsdt.local/svr/api/v1/Processextn/GetAllAssignments.
Für drei Sicherheitsoptionen gibt es die folgenden Routenpräfixe, die für den Zugriff auf die API verwendet werden müssen:
Geheimer Clientschlüssel: „<Evolve URL>/svr“
Sicherheitstoken: „<Evolve URL>/svr“
Zertifikat: „<Evolve URL>/svrc“
Nachfolgend sind die verschiedenen Digital-Access-APIs aufgeführt:
| API-Name | HTTP-Methode | Weiterleiten | Beschreibung |
|---|---|---|---|
| CompleteAssignment | POST | <RoutePrefix>/api/v1/Processextn/CompleteAssignment | Diese API ermöglicht das Abschließen einer vorhandenen offenen Aufgabe. |
| GetAllAssignments | GET | <RoutePrefix>/api/v1/Processextn/GetAllAssignments | Diese API gibt alle offenen Aufgaben mit eingeschränkter Unterstützung des OData-Filters zurück. Dadurch können Daten für einen bestimmten Benutzer oder eine bestimmte Lösung gefiltert werden, indem der OData-Filter in die API-URL übergeben wird. |
| GetDocumentDataByProcess | GET |
<RoutePrefix>/api/v1/Processextn/GetDocumentDataByProcess/<Dokumentart>/<processid>/<Format> Dokumentart: „Excel“ oder „Formular“ Format: „JSON“ oder „XML“ Funktioniert nur bei Formulardokumenten. |
Diese API gibt die neueste Kopie des Dokuments des Prozesses für die angegebene Prozess-ID zurück. |
| StartExcelProcess | POST |
|
Diese API startet einen Excel-Workflow-Prozess. Die übermittelte Excel-Datei wird an die jeweilige Lösungsbibliothek übermittelt. Zudem wird für dieses neue Dokument ein neuer Prozess gestartet. |
| StartFormJsonProcess | POST | <RoutePrefix>/api/v1/Processextn/StartFormJsonProcess | Diese API startet einen Formular-Workflow-Prozess. Die anfänglichen Formulardaten sollten im JSON-Format gesendet werden. Das JSON-Formular sollte gültig sein, da beim Speichern dieser Formulardaten keine Datenvalidierung durchgeführt wird oder Feldregeln ausgeführt werden. |
| StartFormProcess | POST |
<RoutePrefix>/api/v1/Processextn/StartFormProcess |
Diese API ermöglicht das Starten eines Formular-Workflow-Prozesses. Die anfänglichen Formulardaten sollten im XML-Format gesendet werden. Das XML-Formular sollte gültig sein, da beim Speichern dieser Formulardaten keine Datenvalidierung durchgeführt wird oder Regeln ausgeführt werden. |