Document toolboxDocument toolbox

API-Schlüssel

Owned by Sebastian May
Last updated: Aug 06, 2021 by Christopher Stärkel
2 min read

Auf dieser Seite wird beschrieben, wie man API-Schlüssel in Pathfinder verwaltet.

Die Verwaltung der API-Schlüssel finden Sie über die entsprechende Option im Bereich System.

Mithilfe von API-Schlüsseln können Skripte und andere Prozesse ohne herkömmliche LogIn-Daten auf Pathfinder zugreifen (zum Beispeil Pathfinder REST-API oder Kommandozeilenbefehle).

 

[ 1 Erstellung eines API-Schlüssels ] [ 2 Nutzung eines API-Schlüssels ]

 

Erstellung eines API-Schlüssels

Hier werden die API-Schlüssel angezeigt. Sie können neue hinzufügen und bestehende löschen.

Um einen API-Schlüssel zu erzeugen, nutzen Sie das +-Icon.

 

 

 

 

Geben Sie einen Namen und optional eine Beschreibung an.

Legen Sie entweder ein Ablaufdatum fest oder wählen Sie das Kästchen für unbegrenzte Gültigkeit aus.

Über … kopieren Sie den Schlüssel, um ihn in Ihr Script einzufügen oder ihn zu speichern.

 

Hinweis:

  • Aus Sicherheitsgründen ist es nach der Erstellung eines Schlüssels nicht mehr möglich, ihn erneut einzusehen. Geht ein Schlüssel verloren, muss ein neuer erstellt werden.

  • Der Schlüssel sollte, wie jedes Passwort, sicher aufbewahrt werden.

 

 

Nutzung eines API-Schlüssels

Häufig werden API-Schlüssel genutzt, um es Skripten zu ermöglichen, auf die Pathfinder REST-API zuzugreifen.

Ein beispielhafter Aufruf mit curl könnte folgendermaßen aussehen, der Parameter --insecure ist nur erforderlich, falls Sie ein selbst ausgestelltes Zertifikat verwenden:

 

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