API-Schlüssel verwenden

In dieser Anleitung wird beschrieben, wie API-Schlüssel erstellt und API-Schlüsseleinschränkungen eingerichtet werden.

API-Schlüssel sind einfache verschlüsselte Strings, die beim Aufruf bestimmter APIs verwendet werden können, die nicht auf private Nutzerdaten zugreifen müssen. Besonders nützlich sind sie in Clients wie Browsern und mobilen Anwendungen ohne Back-End-Server. Der API-Schlüssel wird verwendet, um für Kontingente und die Abrechnung mit Ihrem Projekt verbundene API-Anfragen zu verfolgen.

Für API-Schlüssel gelten wichtige Einschränkungen wie beispielsweise:

Aus diesem Grund empfehlen wir die Verwendung des Standard-Authentifizierungsvorgangs. Es gibt jedoch einige wenige Fälle, in denen API-Schlüssel geeigneter sind. Wenn Sie beispielsweise eine mobile Anwendung entwickeln, die die Google Cloud Translation API verwenden muss, aber keinen Back-End-Server benötigt, sind API-Schlüssel die einfachste Möglichkeit, sich bei dieser API zu authentifizieren. In den meisten Fällen empfehlen wir, dass Ihre Anwendung mit einem Back-End-Server kommuniziert, der die Authentifizierung und den Aufruf von Google Cloud Platform-Diensten übernimmt.

API-Schlüssel erstellen

  1. Navigieren Sie in der GCP Console zum Bereich APIs & Services → Zugangsdaten.

  2. Wählen Sie Anmeldedaten erstellen und dann aus dem Drop-down-Menü die Option API-Schlüssel.

    API-Schlüssel hinzufügen

  3. Klicken Sie auf Erstellen. Das Dialogfeld API-Schlüssel erstellt enthält den neu erstellten Schlüssel.

Sie sollten den Schlüssel kopieren und sicher aufbewahren. Wenn Sie keinen Testschlüssel verwenden, den Sie später wieder löschen, empfehlen wir, eine API-Schlüsseleinschränkung hinzuzufügen.

API-Schlüssel verwenden

Übergeben Sie den API-Schlüssel als Suchparameter in einem REST API-Aufruf mit dem folgenden Format. Ersetzen Sie dabei API_KEY durch Ihren API-Schlüssel:

key=API_KEY

So übergeben Sie beispielsweise einen API-Schlüssel für eine Cloud Natural Language API-Anfrage für documents.analyzeEntities:

POST https://language.googleapis.com/v1/documents:analyzeEntities?key=API_KEY

API-Schlüssel sichern

Wenn Sie API-Schlüssel in Ihren Anwendungen verwenden, achten Sie auf deren Sicherheit. Wenn Sie Ihre Anmeldedaten öffentlich preisgeben, gefährden Sie damit möglicherweise Ihr Konto, was zu unerwarteten Belastungen ihres Kontos führen könnte. Sie sollten diese Best Practices befolgen, um die Sicherheit Ihrer API-Schlüssel zu wahren:

  • Betten Sie API-Schlüssel nicht direkt in Code ein. In Code eingebettete API-Schlüssel können versehentlich öffentlich zugänglich gemacht werden. Dies kann beispielsweise geschehen, wenn Sie vergessen, die Schlüssel aus freigegebenem Code zu entfernen. Anstatt Ihre API-Schlüssel in Ihre Anwendungen einzubetten, sollten Sie sie in Umgebungsvariablen oder Dateien außerhalb der Quellstruktur der Anwendung speichern.

  • Speichern Sie API-Schlüssel nicht in Dateien in der Quellstruktur der Anwendung. Wenn Sie API-Schlüssel in Dateien speichern, sollten sich diese außerhalb der Quellstruktur der Anwendung befinden, um sicherzustellen, dass Ihre Schlüssel nicht im Verwaltungssystem des Quellcodes landen. Dies ist besonders wichtig, wenn Sie ein öffentliches Quellcode-Verwaltungssystem wie GitHub verwenden.

  • Richten Sie API-Schlüsseleinschränkungen ein, damit die Schlüssel nur von den IP-Adressen, Verweis-URLs und mobilen Apps, die sie benötigen, verwendet werden können.

  • Generieren Sie Ihre API-Schlüssel regelmäßig neu. Klicken Sie dazu auf der Seite "Anmeldedaten" für jeden Schlüssel auf Schlüssel neu generieren. Aktualisieren Sie dann Ihre Anwendungen so, dass sie die neu generierten Schlüssel verwenden. Die alten Schlüssel funktionieren noch 24 Stunden, nachdem Sie Ersatzschlüssel generiert haben.

  • Überprüfen Sie Ihren Code, bevor Sie ihn veröffentlichen. Er sollte keine API-Schlüssel oder anderen privaten Informationen enthalten.

Einschränkungen zu API-Schlüsseln hinzufügen

API-Schlüssel sind standardmäßig uneingeschränkt. Uneingeschränkte Schlüssel sind nicht sicher, da sie öffentlich angezeigt werden können, z. B. mit einem Browser, und auf Geräten zugänglich sind, auf denen sich solche Schlüssel befinden. Sie sollten eine Einschränkung hinzufügen, um Ihren Schlüssel zu sichern.

So fügen Sie eine Einschränkung hinzu:

  1. Klicken Sie im Dialogfeld API-Schlüssel erstellt auf Schlüssel einschränken. Das Konfigurationsfenster API-Schlüssel wird angezeigt:

    API-Schlüsseleinschränkung hinzufügen

  2. Wählen Sie den für Ihre Anwendung geeigneten Einschränkungstyp aus.

    • Für API-Clients, die in einem Webbrowser ausgeführt werden, sollten Sie die Einschränkung HTTP-Verweis-URLs hinzufügen, damit nur die angegebenen Seiten die API aufrufen können. Da diese Arten von Anwendungen ihre API-Schlüssel veröffentlichen, sollten Sie ein Dienstkonto verwenden.

    • Für API-Clients, die auf einem Back-End-Server ausgeführt werden, der keine Dienstkonten unterstützt, sollten Sie die Einschränkung IP-Adressen hinzufügen, um die Verwendung durch Clients mit unterschiedlichen IP-Adressen zu verhindern.

    • Für Android-Apps empfiehlt sich die Einschränkung Android-Apps. Fügen Sie außerdem den Paketnamen und den SHA-1-Signaturzertifikat-Fingerabdruck hinzu.

    • Für iOS-Anwendungen sollten Sie die Einschränkung iOS-Apps auswählen. Fügen Sie außerdem alle vorhandenen iOS-Bundle-IDs hinzu, um API-Aufrufe auf diese iOS-Bundles zu beschränken.

Bei Tests können Sie auf sämtliche Einschränkungen verzichten. Wir empfehlen jedoch, diesem Schlüssel entweder eine Einschränkung hinzuzufügen oder die Einschränkung zu löschen, nachdem Sie Ihre Anwendung in der Produktion bereitgestellt haben.

Weitere Informationen

Hat Ihnen diese Seite weitergeholfen? Teilen Sie uns Ihr Feedback mit:

Feedback geben zu...

dieser Seite
Feedback zur Dokumentation
Authentifizierung
Feedback zum Produkt