Verwalten von API-Schlüsseln

API-Schlüssel dienen als eindeutige Identifikatoren für die Authentifizierung, über die Benutzer, Entwickler oder Programme auf sichere Weise auf eine API zugreifen können. API-Schlüssel werden oft zum Verfolgen und Steuern der API-Nutzung verwendet, um Missbrauch zu verhindern.

Überblick über API-Schlüssel

Im Abschnitt API-Schlüssel der Verwaltungskonsole können Sie alle API-Schlüssel anzeigen, die Ihrem Mandanten zugeordnet sind. Sie können nach Namen, ID oder Besitzer nach Schlüsseln suchen.

API-Schlüssel können die folgenden Status haben:

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

Mandantenadministratoren können die API-Schlüsselgenerierung aktivieren und API-Schlüssel überwachen und widerrufen. Zum Generieren, Bearbeiten oder Löschen von API-Schlüsseln ist die Rolle Entwickler erforderlich. Mandantenadministratoren können diese Rolle Benutzern (auch sich selbst) zuweisen.

Aktivieren von API-Schlüsseln im Mandanten

Standardmäßig sind API-Schlüssel deaktiviert. Mandantenadministratoren können API-Schlüssel im Mandanten aktivieren.

Gehen Sie folgendermaßen vor:

1. Gehen Sie in der Verwaltungskonsole zu Einstellungen.
2. Suchen Sie den Abschnitt API-Schlüssel und wählen Sie API-Schlüssel aktivieren aus.
3. Passen Sie bei Bedarf die folgenden Einstellungen an:

   • Minimales Ablaufdatum für Token ändern: Ändert das Ablaufdatum neu generierter Token. Für vorhandene API-Schlüssel wird das ursprüngliche Ablaufdatum beibehalten. Für den Wert gibt es keine Höchstgrenze.

     InformationshinweisMöglicherweise müssen Sie den Browser aktualisieren, um die Änderungen an diesem Wert im Abschnitt API-Schlüssel Ihrer Benutzerprofilseite anzuzeigen.
   • Maximale Anzahl aktiver API-Schlüssel pro Benutzer ändern: Diese Einstellung betrifft nur neue API-Schlüssel. Wenn das Limit erreicht ist, wird die Erstellung neuer API-Schlüssel verweigert. Der Höchstwert ist 1000.

4. Um mit dem Generieren von API-Schlüsseln zu beginnen, klicken Sie auf Neu generieren. Dadurch werden Sie zum Abschnitt API-Schlüssel auf Ihrer Benutzerprofilseite geleitet, wo Sie neue Schlüssel erstellen können.

Generieren von API-Schlüsseln

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

• Sie haben eine aktive Lizenz.

• API-Schlüssel aktivieren ist in der Verwaltungskonsole eingeschaltet.
• Sie haben die Rolle Entwickler.

Gehen Sie folgendermaßen vor:

1. Klicken Sie oben rechts auf Ihr Benutzerprofilsymbol und wählen Sie Profileinstellungen aus.

2. Klicken Sie im Abschnitt API-Schlüssel auf Neuen Schlüssel generieren.

3. Geben Sie eine Beschreibung und eine Ablaufzeit für den API-Schlüssel an.

4. Klicken Sie auf Generieren, um den Schlüssel zu generieren.

5. Kopieren Sie den generierten API-Schlüssel sofort und speichern Sie ihn an einer sicheren Stelle. Der Schlüssel kann später nicht erneut abgerufen werden.

Nach der Erstellung können Sie den Namen des API-Schlüssels bearbeiten oder diesen bei Bedarf löschen.

Mit dem API-Schlüssel können Sie die REST API-Referenz auf qlik.dev mit Tools wie Postman erkunden, oder installieren Sie qlik-cli, um direkt über die Befehlszeile auf Qlik Funktionen zuzugreifen. Weitere Informationen finden Sie unter Übersicht über Qlik APIs und qlik-cli.

Überwachen und Widerrufen von API-Schlüsseln

Als Mandantenadministrator müssen Sie Aktivitäten mit API-Schlüsseln aus Sicherheitsgründen überwachen. Wenn verdächtige Aktivitäten festgestellt werden, können Sie den API-Schlüssel widerrufen.

Beachten Sie, dass ein API-Schlüssel beim Widerrufen sofort deaktiviert wird, was sich auf laufende Prozesse oder Integrationen auswirkt, die ihn verwenden. Ein Widerruf kann nicht rückgängig gemacht werden, und widerrufene API-Schlüssel können nicht erneut aktiviert werden.

Gehen Sie folgendermaßen vor:

1. Gehen Sie in der Verwaltungskonsole zum Abschnitt Ereignisse.

2. Suchen Sie nach verdächtigen Aktivitäten, wie einer übermäßigen Nutzung eines bestimmten API-Schlüssels.

3. Klicken Sie auf neben dem Ereignis, um seine Details zu erweitern, und kopieren Sie die API-Schlüssel-ID.

4. Gehen Sie zum Abschnitt API-Schlüssel und suchen Sie anhand der ID nach dem API-Schlüssel.

5. Klicken Sie neben dem Schlüssel auf und wählen Sie Widerrufen aus. Sie können nur Schlüssel mit dem Status „Aktiv“ widerrufen.

6. Um mehrere API-Schlüssel zu widerrufen, wählen Sie sie in der Tabelle aus und klicken Sie oben rechts auf Widerrufen.

Löschen von API-Schlüsseln

Durch das Löschen werden API-Schlüssel dauerhaft aus dem System entfernt. Das Löschen eines API-Schlüssels kann nicht rückgängig gemacht werden, und seine Zugriffsrechte werden sofort entfernt. Vergewissern Sie sich, dass durch diese Aktion keine laufenden Prozesse oder Integrationen unterbrochen werden, die den Schlüssel nutzen.

Sie benötigen die Rolle Entwickler, um API-Schlüssel zu löschen.

Gehen Sie folgendermaßen vor:

1. Klicken Sie oben rechts auf Ihr Benutzerprofilsymbol und wählen Sie Profileinstellungen aus.

2. Wählen Sie den Abschnitt API-Schlüssel aus.

3. Klicken Sie neben dem API-Schlüsseln, den Sie löschen möchten, auf und wählen Sie Löschen aus.

4. Wenn Sie alle Schlüssel entfernen möchten, klicken Sie über der Liste der API-Schlüssel auf Alle löschen.