Auf die REST-API zugreifen
Aktivieren Sie die REST-API, legen Sie fest, wie sich Aufrufer authentifizieren, erzeugen Sie einen API-Schlüssel für den Benutzer, unter dem die Integration läuft, und senden Sie Ihre erste authentifizierte Anfrage.
Voraussetzungen
- Erfordert das API-Modul in Ihrer iGrafx-Lizenz. Unter Verwaltung → Lizenz führt die Lizenzverwaltung es als API unter Plattform-Module auf.
- Erfordert einen Plattformadministrator: Nur Administratoren können die API aktivieren und API-Schlüssel erzeugen.
- Der Aufrufer (der Benutzer, dessen Anmeldedaten die Integration verwendet) benötigt die Serverberechtigung Auf REST-API zugreifen sowie eine Lizenz für das, was der jeweilige Endpunkt tut. Legen Sie einen eigenen API-Benutzer an, dessen Berechtigungen und Lizenzen genau dem entsprechen, was die Integration benötigt.
- Zum Öffnen der eingebetteten API-Dokumentation benötigt ein Benutzer die Serverberechtigung Auf Supportfunktionen zugreifen.
Schritte
-
Öffnen Sie die Plattform als Administrator und gehen Sie zu Verwaltung → Support → REST-API.

-
Aktivieren Sie Zugriff über API-Schlüssel gestatten. On-Premises aktivieren Sie zuerst API aktivieren.
-
Erzeugen Sie einen API-Schlüssel für den Benutzer der Integration:
- Gehen Sie zu Verwaltung → Benutzerverwaltung und öffnen Sie den Benutzer (Bearbeiten).
- Klicken Sie unter API-Schlüssel auf API-Schlüssel erzeugen und kopieren Sie den Schlüssel. Behandeln Sie ihn wie ein Passwort: Er erlaubt alles, was dieser Benutzer tun kann, und Sie können ihn nicht mehr abrufen, nachdem Sie die Seite verlassen haben.
-
Senden Sie den Schlüssel bei jeder Anfrage im Header
X-AUTH-APIKEY:curl -H "X-AUTH-APIKEY: YOUR_KEY_HERE" https://your-igrafx-host/api/info/version
Überprüfen
Ein Aufruf von GET /api/info/version gibt die Plattformversion zurück. Das bestätigt, dass die API aktiviert ist, Ihre Authentifizierung funktioniert und dieser Benutzer die API erreicht.
Fehlerbehebung
Wenn ein Aufruf fehlschlägt, prüfen Sie den Antwortstatus:
- 401 oder 403 – die Authentifizierung ist fehlgeschlagen. Prüfen Sie, ob der API-Schlüssel gültig und nicht widerrufen ist und ob er im Header
X-AUTH-APIKEYgesendet wird, exakt so geschrieben. - 400 – die Anfrage wurde abgelehnt. Prüfen Sie den Anfragetext auf gültiges JSON (achten Sie auf das Escaping von Anführungszeichen) und, wenn der Aufruf eine Abfrage enthält, auf gültige iGrafx Query Language (IQL).
Ein erfolgreicher Aufruf gibt 200 mit einem JSON-Text zurück.
Live Testing gibt 401 zurück
Die Funktion Live Testing in der eingebetteten API-Dokumentation authentifiziert sich per Basic Authentication: mit Ihrem Benutzernamen und dem Passwort, das für Ihr Konto in der Datenbank der iGrafx Platform gespeichert ist. Wenn Sie sich per Single Sign-On (SSOSSO Ein Authentifizierungsverfahren, bei dem sich Benutzer einmal bei einem Identitätsanbieter anmelden und dann auf Process360 Live zugreifen, ohne ihre Anmeldedaten erneut einzugeben.) anmelden – oder Ihr Konto aus Active Directory/LDAP oder SCIM stammt –, liegt Ihr Passwort bei Ihrem Identitätsanbieter. Es gibt dann kein Plattformpasswort, das die Basic Authentication verwenden könnte, und der Aufruf gibt 401 zurück. Ein API-Schlüssel hilft nicht: Er funktioniert in einem REST-Client, aber Live Testing kann ihn nicht verwenden.
- Lokales Konto: Bitten Sie einen Administrator, unter Verwaltung → Benutzerverwaltung ein Plattformpasswort für Ihren Benutzer festzulegen, und verwenden Sie dieses Passwort dann in Live Testing.
- SSOSSO Ein Authentifizierungsverfahren, bei dem sich Benutzer einmal bei einem Identitätsanbieter anmelden und dann auf Process360 Live zugreifen, ohne ihre Anmeldedaten erneut einzugeben.-, Active-Directory/LDAP- oder SCIM-Konto: Testen Sie stattdessen mit einem REST-Client wie Postman und senden Sie den API-Schlüssel wie oben beschrieben im Header
X-AUTH-APIKEY.