API-Schlüssel

Wenn Sie über die REST-API oder die Kommandozeile mit Pathfinder arbeiten, können Sie sich mithilfe von API-Schlüsseln authentifizieren.

Wählen Sie API-Schlüssel im Systembereich aus.

API-Schlüssel erstellen

Hier wird eine Liste aller existierenden API-Schlüssel angezeigt. Sie können weitere hinzufügen und bestehende löschen.

Geben Sie dem API-Schlüssel zunächst einen Namen und hinterlegen Sie eine Beschreibung.

Legen Sie außerdem das Ablaufdatum fest. Bitte beachten Sie, dass dieses nicht nachträglich angepasst werden kann.

Unterhalb wird der automatisch generierte Schlüssel angezeigt, den Sie über einen Klick auf … kopieren können.

Mit einem Klick auf Ok schließen Sie den Vorgang ab.

Hinweis:

Aus Sicherheitsgründen kann der Schlüssel nachträglich nicht erneut angezeigt werden. Bei Verlust des Schlüssels muss ein neuer angelegt werden.
Mit einem API-Schlüssel erhält jeder Zugriff auf die in Pathfinder hinterlegten Daten. Er sollte daher wie ein Passwort aufbewahrt werden.

Ein klassischer Anwendungsfall für API-Schlüssel ist die Nutzung für die Authentifizierung in Skripten, die auf die REST-API zugreifen.

Ein Beispielaufruf mit curl könnte wie folgt aussehen:

CODE

curl --header 'Authorization:API-SCHLÜSSEL' --insecure https://SERVER-ADRESSE:8087/api/v1.0/info/status/ping

Der Parameter --insecure ist nur nötig, wenn ein selbstsigniertes Zertifikat verwendet wird.