Verwalten von API-Schlüsseln

API-Schlüssel sind eindeutige Identifikatoren für die Authentifizierung, über die Benutzer, Entwickler oder Programme auf sichere Weise auf APIs zugreifen können. Sie sind wesentlich für die Verfolgung und Kontrolle der API-Nutzung, um Missbrauch zu verhindern und eine sichere Kommunikation zu gewährleisten.

Verwenden von API-Schlüsseln zum Verbinden mit Qlik Cloud APIs

Sie können API-Schlüssel verwenden, um mit der REST-API-Referenz auf qlik.dev zu interagieren. Tools wie Postman oder qlik-cli können für den API-Zugriff verwendet werden. Weitere Informationen finden Sie unter Übersicht über Qlik APIs und qlik-cli.

Beispiel: Verwenden von Postman zum Herstellen einer Verbindung zu Qlik APIs

Gehen Sie folgendermaßen vor:

Starten Sie Postman.
Legen Sie die HTTP-Methode auf GET fest.
Geben Sie die URL für den Qlik Cloud API-Endpunkt ein.

Gehen Sie z. B. wie folgt vor, um alle Bereiche im Mandanten aufzulisten:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Wählen Sie auf der Registerkarte Authentifizierung die Option Bearer Token als Authentifizierungstyp aus.
Geben Sie den API-Schlüssel in das Feld Token ein.
Klicken Sie auf Senden.

Wenn die Anforderung erfolgreich ist, gibt die API eine JSON-Antwort zurück. In diesem Beispiel besteht die Antwort in einer Liste von Bereichen.

Aktivieren von API-Schlüsseln im Mandanten

Standardmäßig ist die API-Schlüsselgenerierung deaktiviert. Mandantenadministratoren müssen API-Schlüssel im Mandanten aktivieren, damit Benutzer sie generieren können.

Gehen Sie folgendermaßen vor:

Gehen Sie im Aktivitätscenter Verwaltung zu Einstellungen.
Wählen Sie unter API-Schlüssel die Option API-Schlüssel aktivieren aus.
Passen Sie bei Bedarf die folgenden Einstellungen an:
- Maximales 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.
- Maximale Anzahl aktiver API-Schlüssel pro Benutzer ändern: Dieses Limit betrifft nur neue API-Schlüssel. Wenn das Limit erreicht ist, wird die Erstellung weiterer API-Schlüssel verweigert. Der höchste Wert, der festgelegt werden kann, ist 1000.
InformationshinweisMöglicherweise müssen Sie den Browser aktualisieren, um die Änderungen im Abschnitt API-Schlüssel Ihrer Benutzerprofilseite anzuzeigen.
Um mit dem Generieren von API-Schlüsseln zu beginnen, klicken Sie auf Neu generieren. Sie werden zum Abschnitt API-Schlüssel Ihres Benutzerprofils weitergeleitet.

Generieren und Verwalten von API-Schlüsseln

Generieren von API-Schlüsseln

Zum Generieren neuer API-Schlüssel benötigen Sie die Rolle Entwickler. Mandantenadministratoren können diese Rolle Benutzern zuweisen.

Gehen Sie folgendermaßen vor:

Klicken Sie auf Ihr Benutzerprofil und wählen Sie Profileinstellungen aus.
Klicken Sie im Abschnitt API-Schlüssel auf Neuen Schlüssel generieren.
Geben Sie eine Beschreibung an und legen Sie eine Ablaufzeit für den API-Schlüssel fest.
Klicken Sie auf Generieren, um den Schlüssel zu generieren.
Kopieren Sie den generierten API-Schlüssel und speichern Sie ihn auf sichere Weise. Beachten Sie, dass der Schlüssel später nicht erneut abgerufen werden kann.

Bearbeiten von API-Schlüsseln

Sie können den Namen eines API-Schlüssels nach der Erstellung ändern.

Löschen von API-Schlüsseln

Das Löschen von API-Schlüsseln ist dauerhaft und kann nicht rückgängig gemacht werden. Vergewissern Sie sich, dass durch diese Aktion keine laufenden Prozesse oder Integrationen unterbrochen werden, die den Schlüssel nutzen.

Gehen Sie folgendermaßen vor:

Klicken Sie auf Ihr Benutzerprofil und wählen Sie Profileinstellungen aus.
Wechseln Sie zum Abschnitt API-Schlüssel.
Klicken Sie neben dem API-Schlüsseln, den Sie löschen möchten, auf und wählen Sie Löschen aus.
Wenn Sie alle Schlüssel entfernen möchten, klicken Sie über der Schlüsselliste auf Alle löschen.

Überwachen und Widerrufen von API-Schlüsseln

Im Abschnitt API-Schlüssel des Aktivitätscenters Verwaltung 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üsselstatus

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.

Widerrufen von API-Schlüsseln

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

Ein API-Schlüssel wird beim Widerrufen sofort deaktiviert, 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:

Gehen Sie im Aktivitätscenter Verwaltung zu Ereignisse.
Suchen Sie nach verdächtigen Aktivitäten, wie einer übermäßigen Nutzung eines bestimmten API-Schlüssels.
Klicken Sie auf neben dem Ereignis, um seine Details zu erweitern, und kopieren Sie die API-Schlüssel-ID.
Gehen Sie zum Abschnitt API-Schlüssel und suchen Sie anhand der ID nach dem API-Schlüssel.
Klicken Sie neben dem Schlüssel auf und wählen Sie Widerrufen aus. Sie können nur Schlüssel mit dem Status „Aktiv“ widerrufen.
Um mehrere API-Schlüssel zu widerrufen, wählen Sie sie in der Tabelle aus und klicken Sie oben rechts auf Widerrufen.

Best Practices für die Verwaltung von API-Schlüsseln

Schlüssel vertraulich halten: Speichern Sie API-Schlüssel auf sichere Weise und vermeiden Sie es, sie in öffentlichen Code-Repositorys offenzulegen.
Regelmäßig neu generieren: Generieren Sie Ihre API-Schlüssel regelmäßig neu, um die Sicherheit zu erhöhen.
Nutzung überwachen: Überprüfen Sie regelmäßig die Aktivitäten der API-Schlüssel, um verdächtiges Verhalten zu erkennen.

Hat diese Seite Ihnen geholfen?

Wenn Sie Probleme mit dieser Seite oder ihren Inhalten feststellen – einen Tippfehler, einen fehlenden Schritt oder einen technischen Fehler –, teilen Sie uns bitte mit, wie wir uns verbessern können!

Geben Sie hier Ihr Feedback ab