Zu Hauptinhalt springen

Verwalten von API-Schlüsseln

Ein API-Schlüssel ist ein eindeutiger Identifikator, der zur Authentifizierung eines Benutzers, Entwicklers oder Aufrufprogramms in einer API verwendet wird. API-Schlüssel werden oft zum Verfolgen und Steuern der Nutzung der Benutzeroberfläche genutzt, um eine missbräuchliche Verwendung der API zu verhindern.

Überblick über API-Schlüssel

Standardmäßig sind die API-Schlüssel in der Verwaltungskonsole deaktiviert. Um die API-Schlüssel zu aktivieren, gehen Sie zum Abschnitt Einstellungen. Ein Mandantenadministrator kann API-Schlüssel widerrufen und die API-Schlüsseleinstellungen bearbeiten. Zum Generieren oder Löschen von API-Schlüsseln ist jedoch die Rolle Entwickler erforderlich. Ein Mandantenadministrator weist die Rolle Entwickler einem Benutzer zu. Wenn Sie Mandantenadministrator sind, können Sie die Rolle „Entwickler“ sich selbst zuweisen.

Die API-Schlüsseltabelle zeigt die folgenden Informationen über die API-Schlüssel: Name, ID, Besitzer, letzte Aktualisierung, Erstellungsdatum, Ablaufdatum und Status. Verwenden Sie das Suchfeld, um in den ersten drei Feldern zu suchen: Schlüsselname, Schlüssel-ID und Besitzer.

API-Schlüsselstatus

API-Schlüssel können folgende Status haben:

  • Aktiv: Der API-Schlüssel wird verwendet.
  • Abgelaufen: Das Ablaufdatum wurde erreicht.
  • Widerrufen: Der API-Schlüssel wurde widerrufen und kann nicht mehr verwendet werden.

Als Administrator können Sie die API-Schlüsselaktivitäten überprüfen, die im Abschnitt Ereignisse der Verwaltungskonsole registriert wurden. Wenn verdächtige Aktivitäten festgestellt werden, wie z. B. die häufige Nutzung eines bestimmten API-Schlüssel, können Sie diesen API-Schlüssel widerrufen. Öffnen Sie die Detailliste, indem Sie auf den Pfeil ganz rechts in der Tabelle klicken, und kopieren Sie die ID des API-Schlüssels. Dann können Sie im Abschnitt API-Schlüssel nach der ID suchen, um den API-Schlüssel zu finden, der widerrufen werden soll.

Um einen einzelnen API-Schlüssel zu widerrufen, klicken Sie auf die Schaltfläche ... ganz rechts und wählen Sie Widerrufen aus. Sie können nur Schlüssel mit dem Status Aktiv widerrufen. Um mehrere Schlüssel zu widerrufen, aktivieren Sie die Kontrollkästchen links neben den betreffenden Schlüsseln und klicken Sie oben rechts auf Widerrufen. Ein Widerruf kann nicht rückgängig gemacht werden. Es ist nicht möglich, einen widerrufenen API-Schlüssel wieder zu aktivieren.

Zusätzlich zum Widerruf ist auch die Löschoption vorhanden. Sie können einen API-Schlüssel im Hub, aber nicht in der Verwaltungskonsole löschen.

Aktivieren von API-Schlüsseln im Mandanten

Die Einstellung API-Schlüssel aktivieren wird in der Verwaltungskonsole auf der Seite Einstellungen aktiviert. Standardmäßig sind die API-Schlüssel in der Verwaltungskonsole deaktiviert.

Eigenschaften für API-Schlüssel
Eigenschaft Beschreibung
API-Schlüssel aktivieren

Über diesen Schalter können alle API-Schlüssel im Mandanten aktiviert oder deaktiviert werden. Nur der Mandantenadministrator kann die API-Schlüssel aktivieren.

Maximales Ablaufdatum für Token ändern

Wenn das Ablaufdatum für Token geändert wird, erhalten alle neuen Token den neuen Wert für das Ablaufdatum. Bereits vorhandene APIs sind von der Änderung nicht betroffen. Sie weisen den gleichen Ablaufwert wie vorher auf.

Maximale Anzahl der API-Schlüssel pro Benutzer ändern

Die Einstellung wirkt sich nur auf neue API-Schlüssel aus. Wenn bei einem neuen API-Schlüssel die Gesamtzahl die maximale Anzahl überschreitet, wird die Erstellung verweigert.

Gehen Sie folgendermaßen vor:

  1. Gehen Sie in der Verwaltungskonsole zur Seite Einstellungen.
  2. Aktivieren Sie im Abschnitt API-Schlüssel die Option API-Schlüssel aktivieren.
  3. Ändern Sie bei Bedarf die Einstellungen Maximales Ablaufdatum für Token ändern und Maximale Anzahl der API-Schlüssel pro Benutzer ändern.

Generieren eines API-Schlüssels im Hub

Sie können API-Schlüssel im Hub generieren. Bevor Sie beginnen, vergewissern Sie sich, dass drei Voraussetzungen erfüllt sind:

  • Sie verwenden eine Lizenz. Eine Lizenz ist zum Generieren eines API-Schlüssels erforderlich.

  • Die Einstellung API-Schlüssel aktivieren ist in der Verwaltungskonsole aktiviert.
  • Der Mandantenadministrator hat Ihnen die Rolle Entwickler zugewiesen.

Gehen Sie folgendermaßen vor:

  1. Melden Sie sich bei Ihrem Mandaten an, beispielsweise https://<mandantenname>.com.

  2. Klicken Sie oben rechts auf Ihr Profil und wählen Sie Profileinstellungen aus.

  3. Wählen Sie API-Schlüssel aus.

  4. Klicken Sie auf Neuen Schlüssel generieren.

  5. Geben Sie eine API-Schlüsselbeschreibung ein und wählen Sie, wann der API-Schlüssel ablaufen soll.

  6. Klicken Sie auf Generieren.

    Ein API-Schlüssel wird generiert.

  7. Kopieren Sie den API-Schlüssel und speichern Sie ihn an einem sicheren Ort.

Nach der Erstellung können Sie den Namen des API-Schlüssels bearbeiten. Sie können ihn auch löschen.