API-Zugänge verwalten

Mit API-Zugängen lassen Sie externe Programme und Dienste sicher auf HEXLE zugreifen, ohne Ihre persönlichen Anmeldedaten weiterzugeben. Im HEXLE HUB können Sie API-Zugänge selbst erstellen, ihnen passende Berechtigungen zuweisen, sie bei Bedarf vorübergehend deaktivieren oder dauerhaft löschen.

In dieser Anleitung zeigen wir Ihnen, wie Sie Ihre API-Zugänge verwalten. Bewahren Sie API-Schlüssel stets sicher auf, da sie wie ein Passwort Zugriff auf Ihre Daten gewähren.

API-Zugänge öffnen

1. Öffnen Sie im HEXLE HUB den Bereich API-Zugänge.

2. Sie sehen eine Liste Ihrer bestehenden API-Zugänge mit Bezeichnung, Status (aktiv oder deaktiviert) und Erstellungsdatum.

API-Zugang erstellen

Beim Erstellen eines neuen API-Zugangs übernimmt dieser zunächst die Berechtigungen und den Unternehmenskontext Ihrer aktuellen Anmeldung. Der zugehörige API-Schlüssel wird Ihnen aus Sicherheitsgründen nur ein einziges Mal angezeigt.

1. Klicken Sie im Bereich API-Zugänge auf API-Zugang erstellen.

2. Vergeben Sie eine aussagekräftige Bezeichnung, anhand derer Sie den Zugang später wiedererkennen (zum Beispiel den Namen des Programms, das ihn nutzt). Bestätigen Sie die Erstellung.

3. Nach dem Erstellen werden Ihnen der API-Benutzername und der API-Schlüssel angezeigt. Kopieren Sie den API-Schlüssel jetzt und bewahren Sie ihn sicher auf, denn er wird Ihnen kein zweites Mal angezeigt.

Sollten Sie den API-Schlüssel verlieren, können Sie ihn nicht erneut anzeigen. Erstellen Sie in diesem Fall einen neuen API-Zugang und löschen Sie den alten.

Berechtigungen (Rollen) zuweisen

Sie können einem API-Zugang gezielt Rollen zuweisen oder entziehen und so genau festlegen, worauf er zugreifen darf. Zuweisen können Sie dabei nur Rollen, die Sie selbst besitzen.

1. Klicken Sie in der Liste beim gewünschten API-Zugang auf Berechtigungen bzw. Rollen.

2. Sie sehen die verfügbaren Rollen Ihres Unternehmens. Bereits zugewiesene Rollen sind markiert. Aktivieren oder deaktivieren Sie die gewünschten Rollen.

3. Speichern Sie Ihre Auswahl. Die Berechtigungen des API-Zugangs werden entsprechend aktualisiert.

API-Zugang deaktivieren

Möchten Sie einen API-Zugang vorübergehend sperren, ohne ihn zu löschen, können Sie ihn deaktivieren. Ein deaktivierter Zugang kann nicht mehr auf HEXLE zugreifen, bleibt aber in Ihrer Liste erhalten.

1. Klicken Sie in der Liste beim gewünschten API-Zugang auf Deaktivieren.

2. Der Zugang wird in der Liste als deaktiviert gekennzeichnet.

API-Zugang löschen

Wird ein API-Zugang nicht mehr benötigt, können Sie ihn dauerhaft löschen. Dabei wird auch der zugehörige technische Benutzer entfernt. Diese Aktion kann nicht rückgängig gemacht werden.

1. Klicken Sie in der Liste beim gewünschten API-Zugang auf Löschen.

2. Bestätigen Sie die Löschung. Der API-Zugang wird endgültig entfernt und kann nicht mehr verwendet werden.