Zum Hauptinhalt springen

API-Ressourcen

Mit der REST-API von iGrafx Process360 LiveProcess360 Live Die Cloud-Plattform von iGrafx für durchgängiges Prozessmanagement – sie vereint Prozessdesign, Mining, Simulation und Automatisierung in einer einzigen Umgebung. arbeiten Sie aus Ihrem eigenen Code heraus mit der Plattform: Repository-Objekte lesen und schreiben, Berichte ausführen, Benutzer verwalten und mehr. Sie ist in der Cloud und On-Premises verfügbar und gehört seit Version 16.2 zur Plattform.

Überblick​

Über eine REST-API arbeitet ein Programm über das Web mit einem anderen zusammen. Ihr Code sendet eine HTTP-Anfrage an eine URL, die angibt, was Sie möchten – ein Repository-Objekt, einen Bericht, einen Benutzer –, und die API sendet die Antwort als JSON zurück, ganz ähnlich wie ein Browser eine Seite anfordert. Die HTTP-Methode sagt, was damit geschehen soll: GET liest, POST erstellt, PUT aktualisiert, DELETE entfernt. Jede Anfrage bringt ihre eigene Authentifizierung mit, daher gibt es keine Sitzung, die geöffnet oder offen gehalten werden muss.

Anfragen gehen an Pfade unter /api (zum Beispiel GET /api/info/version). Jeder Aufruf wird als Plattformbenutzer authentifiziert, und die API setzt die Berechtigungen und Lizenzen dieses Benutzers durch. Eine Integration kann also nur das tun, was der Benutzer dahinter tun darf.

Die REST-API erfordert das API-Modul in Ihrer iGrafx-Lizenz. Die API ist standardmäßig deaktiviert. Ein Administrator aktiviert sie und vergibt die passenden Berechtigungen, bevor sich eine Integration verbinden kann. Siehe Auf die REST-API zugreifen.

Aufrufer authentifizieren sich mit einem API-Schlüssel – einem benutzerbezogenen Schlüssel, der im Anfrage-Header X-AUTH-APIKEY gesendet wird. Der Schlüssel trägt alle Berechtigungen dieses Benutzers. Behandeln Sie ihn daher wie ein Passwort, und betreiben Sie die Plattform über HTTPS, damit der Schlüssel bei der Übertragung nicht offengelegt wird.

Hinweis

Diese Seiten behandeln die iGrafx-REST-API selbst: ihre Endpunkte, wie sich Aufrufer authentifizieren und was zwischen Releases kompatibel bleibt. Sie vermitteln keine Grundlagen zu REST oder HTTP – dafür nutzen Sie die allgemein verfügbaren Materialien im Internet. Geführte iGrafx-Schulungen finden Sie im Kurskatalog der iGrafx University.

Wo Sie die API-Dokumentation finden​

Die Dokumentation zu den einzelnen Endpunkten wird aus der API selbst erzeugt und passt daher immer zu Ihrer Version:

  • Cloud (SaaS): die gehostete Referenz unter https://api.igrafx.com.
  • Cloud und On-Premises: die eingebettete Dokumentation im Produkt unter Verwaltung → Support → REST-API (der Link iGrafx Platform API-Dokumentation). Dort können Sie Endpunkte direkt testen. Zum Anzeigen ist die Serverberechtigung Auf Supportfunktionen zugreifen erforderlich.

Cloud und On-Premises​

Die REST-API funktioniert in beiden Umgebungen gleich, aber nicht jeden Endpunkt gibt es in beiden. Ist eine Funktion nur in der Cloud verfügbar, gilt das auch für die zugehörigen Endpunkte. Das Rendern von Diagrammen und das Herunterladen von Prozesssteckbriefen laufen zum Beispiel als Cloud-Jobs und werden On-Premises nicht bereitgestellt. Siehe Diagramme und Prozesssteckbriefe herunterladen.

API-Leitfäden: