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.

video thumbnail

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

Sie können API-Schlüssel verwenden, um mit der Qlik REST-API-Referenz 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

Diese Einstellung ist veraltet und wird in einer künftigen Version entfernt. Nach der Entfernung wird die Erstellung von API-Schlüsseln ausschließlich über die Berechtigung API-Schlüssel verwalten gesteuert.

Mandantenadministratoren können steuern, ob Benutzer API-Schlüssel im Mandanten generieren können.

Gehen Sie folgendermaßen vor:

Gehen Sie im Aktivitätscenter Administration zur Seite Einstellungen.
Wählen Sie die Registerkarte Funktionssteuerung aus.
Aktivieren oder deaktivieren Sie im Abschnitt API-Schlüssel die Option API-Schlüssel aktivieren.

Konfigurieren anderer API-Schlüssel-Einstellungen

Gehen Sie folgendermaßen vor:

Gehen Sie im Aktivitätscenter Administration zur Seite Einstellungen.
Wählen Sie die Registerkarte Funktionssteuerung aus.
Passen Sie im Abschnitt API-Schlüssel die folgenden Einstellungen nach Bedarf an:
- Maximales Ablaufdatum für Token ändern: Legen Sie das Ablaufdatum neu generierter API-Token fest. Für vorhandene API-Schlüssel wird das ursprüngliche Ablaufdatum beibehalten. Für diesen Wert gibt es keine Obergrenze.
- Maximale Anzahl aktiver API-Schlüssel pro Benutzer ändern: Legen Sie fest, wie viele API-Schlüssel ein Benutzer haben darf. Dieses Limit gilt nur für neue Schlüssel. Wenn das Limit erreicht ist, können Benutzer keine weiteren Schlüssel erstellen. Der Höchstwert ist 1000.

Möglicherweise müssen Sie den Browser aktualisieren, damit Sie die Änderungen im Abschnitt API-Schlüssel Ihrer Seite für persönliche Einstellungen sehen.

Generieren und Verwalten von API-Schlüsseln

Generieren von API-Schlüsseln

Um neue API-Schlüssel zu generieren, müssen Sie über eine benutzerdefinierte Rolle mit der Berechtigung API-Schlüssel verwalten verfügen, oder die Berechtigung muss in den Benutzerstandard-Einstellungen aktiviert sein.

Gehen Sie folgendermaßen vor:

Klicken Sie auf Ihr Benutzerprofilsymbol und wählen Sie Einstellungen 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 Benutzerprofilsymbol und wählen Sie Einstellungen 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 Administration 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 Administration 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 ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!

Geben Sie hier Ihr Feedback ab