Versions Compared

Old Version 2

changes.mady.by.user Thomas Wais

Saved on

compared with

New Version 3

changes.mady.by.user Christopher Stärkel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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).

Table of Contents
maxLevel4
minLevel2
typeflat

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.

Info

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,

mit einfacher HTTP-Authentifizierung

auf die Pathfinder REST-API zuzugreifen.

Abhängig von der genutzten HTTP-Bibliothek können Sie einfach Ihr Passwort durch den Schlüssel ersetzen. So könnte ein

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

Code Block
breakoutModefull-width
curl --vheader https://pathfinderserver:8081‘Authorization:API-KEY' --userinsecure myuserhttps:my-api-key
Beachten Sie, dass myuser hier durch den Benutzer ersetzt werden muss, der genutzt wurde, um den Schlüssel zu erstellen.
//SERVER-ADRESSE:8087/api/v1.0/info/status/ping


⬅ Manage Functional Permissions

Command Line Interface➡