Damit Sie die Looker API verwenden können, müssen Sie sich zuerst authentifizieren. Welche Schritte Sie ausführen müssen, hängt davon ab, ob Sie ein SDK verwenden.
Authentifizierung mit einem SDK
Dies ist die empfohlene Methode für die API-Authentifizierung:
Erstellen Sie API-Anmeldedaten auf der Seite Nutzer im Bereich „Verwaltung“ Ihrer Looker-Instanz. Wenn Sie kein Looker-Administrator sind, bitten Sie Ihren Looker-Administrator, die API-Anmeldedaten für Sie zu erstellen.
API-Anmeldedaten sind immer an ein Looker-Nutzerkonto gebunden. API-Anfragen werden „als“ der Nutzer ausgeführt, der mit den API-Anmeldedaten verknüpft ist. API-Aufrufe geben nur Daten zurück, die der Nutzer sehen darf, und ändern nur Daten, die der Nutzer ändern darf.
Die von Ihnen generierten API-Anmeldedaten enthalten eine Client-ID und ein Client-Secret. Sie müssen diese dem SDK zur Verfügung stellen. Eine Anleitung dazu finden Sie in der SDK-Dokumentation.
Das SDK kümmert sich dann darum, die erforderlichen Zugriffstokens abzurufen und in alle nachfolgenden API-Anfragen einzufügen.
Authentifizierung ohne SDK
Die API-Authentifizierung mit einem SDK wird empfohlen. So authentifizierst du dich ohne SDK:
Erstellen Sie API-Anmeldedaten auf der Seite Nutzer im Bereich „Verwaltung“ Ihrer Looker-Instanz. Wenn Sie kein Looker-Administrator sind, bitten Sie Ihren Looker-Administrator, die API-Anmeldedaten für Sie zu erstellen.
API-Anmeldedaten sind immer an ein Looker-Nutzerkonto gebunden. API-Anfragen werden „als“ der Nutzer ausgeführt, der mit den API-Anmeldedaten verknüpft ist. API-Aufrufe geben nur Daten zurück, die der Nutzer sehen darf, und ändern nur Daten, die der Nutzer ändern darf.
Rufe den Endpunkt
login
der API auf, um ein kurzfristiges OAuth 2.0-Zugriffstoken zu erhalten. Sie müssen die API-Anmeldedaten angeben, die Sie in Schritt 1 generiert haben, einschließlich einer Client-ID und eines Clientschlüssels.Fügen Sie dieses Zugriffstoken in den HTTP-Autorisierungsheader der Looker API-Anfragen ein. Eine Beispiel-Looker API-Anfrage mit einem Autorisierungsheader könnte so aussehen:
GET /api/4.0/user HTTP/1.1 Host: test.looker.com Date: Wed, 19 Oct 2023 12:34:56 -0700 Authorization: token mt6Xc8jJC9GfJzKBQ5SqFZTZRVX8KY6k49TMPS8F
Das OAuth 2.0-Zugriffstoken kann für mehrere API-Anfragen verwendet werden, bis es abläuft oder durch Aufrufen des Endpunkts logout
ungültig wird. API-Anfragen, die ein abgelaufenes Zugriffstoken verwenden, schlagen mit einer 401 Authorization Required
-HTTP-Antwort fehl.
API-Interaktion mit den Anmeldeeinstellungen von Nutzern
Die Looker API-Authentifizierung ist völlig unabhängig von der Anmeldung von Looker-Nutzern. Protokolle zur Nutzerauthentifizierung wie Einmalpasswörter (OTP, 2FA) und Verzeichnisauthentifizierung (LDAP, SAML usw.) gelten nicht für die Authentifizierung der Looker API.
Wenn Sie die Informationen eines Nutzers aus einem Nutzerauthentifizierungsprotokoll löschen, werden seine API-Anmeldedaten daher nicht gelöscht. Wenn Sie die Verfahren auf der Dokumentationsseite Löschen personenbezogener Nutzerdaten ausführen, werden alle personenbezogenen Daten eines Nutzers aus Looker entfernt. Er kann sich dann nicht mehr anmelden, auch nicht über die API.
API-Anmeldedaten verwalten
- Mehrere API-Anmeldedaten können einem einzelnen Looker-Nutzerkonto zugeordnet werden.
- API-Anmeldedaten können erstellt und gelöscht werden, ohne dass sich das auf den Status des Nutzerkontos auswirkt.
- Wenn Sie ein Looker-Nutzerkonto löschen, werden alle API-Anmeldedaten ungültig, die mit dem Nutzerkonto verknüpft sind.
- Das API-Client-Secret muss vertraulich behandelt werden. Speichern Sie API-Client-Secrets nicht im Quellcode oder an anderen Orten, an denen sie von vielen Personen gesehen werden können.
- Verwenden Sie in der Produktion keine API-Anmeldedaten, die an Looker-Administratorkonten gebunden sind. Erstellen Sie Nutzerkonten mit minimalen Berechtigungen speziell für API-Aktivitäten (häufig als „Dienstkonten“ bezeichnet) und erstellen Sie API-Anmeldedaten für diese Konten. Gewähren Sie nur die Berechtigungen, die für die vorgesehenen API-Aktivitäten erforderlich sind.
HTTPS-Authentifizierung
Auch wenn Sie ein Client-SDK verwenden, das die Authentifizierungsdetails für Sie übernimmt, möchten Sie vielleicht wissen, wie die Authentifizierung der Looker API funktioniert. Detaillierte Informationen zur Authentifizierung finden Sie auf GitHub unter How to Authenticate to the Looker API (So authentifizieren Sie sich bei der Looker API).
Authentifizierung mit OAuth
Looker kann das Cross-Origin Resource Sharing (CORS)-Protokoll verwenden, damit Webanwendungen die Looker API von außerhalb der Domain einer Looker-Instanz aufrufen können. Informationen zum Konfigurieren der CORS-Authentifizierung finden Sie auf der Dokumentationsseite Looker API-Authentifizierung mit OAuth.