API-Schlüssel mit der Air Quality API verwenden

Google Maps Platform-Produkte sind vor unbefugter Nutzung geschützt, da API-Aufrufe nur nach Eingabe korrekter Authentifizierungsdaten möglich sind. Diese Daten werden als API-Schlüssel bereitgestellt. Das ist ein eindeutiger alphanumerischer String, über den Ihr Google-Rechnungskonto mit Ihrem Projekt und der jeweiligen API oder dem jeweiligen SDK verknüpft ist.

In diesem Leitfaden wird beschrieben, wie Sie einen API-Schlüssel für die Google Maps Platform erstellen, einschränken und verwenden.

Hinweis : Um die Air Quality API nutzen zu können, benötigen Sie ein Projekt mit einem Rechnungskonto. Außerdem muss die Air Quality API aktiviert sein. Wir empfehlen, mehrere Project Owners und Billing Administrators einzurichten, damit immer jemand aus Ihrem Team die entsprechenden Aufgaben übernehmen kann. Weitere Informationen finden Sie unter Google Cloud-Projekt einrichten.

API-Schlüssel erstellen

Der API-Schlüssel ist eine eindeutige Kennung. Damit werden die mit Ihrem Projekt verknüpften Anfragen zu Nutzungs- und Abrechnungszwecken authentifiziert. Mit Ihrem Projekt muss mindestens ein API-Schlüssel verknüpft sein.

So erstellen Sie einen API-Schlüssel:

Cloud Console

1. Rufen Sie die Seite Google Maps Platform > Anmeldedaten auf.

   Zur Seite „Anmeldedaten“

2. Klicken Sie auf der Seite Anmeldedaten auf Anmeldedaten erstellen > API-Schlüssel.
   Im Dialogfeld API-Schlüssel erstellt wird der neu erstellte API-Schlüssel angezeigt.
3. Klicken Sie auf Schließen.
   Der neue API-Schlüssel wird auf der Seite Anmeldedaten unter API-Schlüssel aufgeführt.
   Es empfiehlt sich, den API-Schlüssel einzuschränken, bevor Sie ihn in der Produktionsumgebung verwenden.

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Weitere Informationen zum Google Cloud SDK, zur Cloud SDK-Installation und zu folgenden Befehlen:

• gcloud alpha services api-keys create

API-Schlüssel einschränken

Google empfiehlt dringend, die API-Schlüssel einzuschränken, indem Sie ihre Nutzung auf die APIs beschränken, die für Ihre App erforderlich sind. Wenn Sie Ihre API-Schlüssel einschränken, wird Ihre App sicherer und es wird dafür gesorgt, dass nur autorisierte Anfragen gesendet werden. Weitere Informationen finden Sie unter Best Practices für die API-Sicherheit.

Wenn Sie die Nutzung eines API-Schlüssels in der Cloud Console einschränken, werden durch Anwendungseinschränkungen alle APIs überschrieben, die unter API-Einschränkungen aktiviert sind. Befolgen Sie die Best Practices und erstellen Sie einen separaten API-Schlüssel für jede App und für jede Plattform, auf der die App verfügbar ist.

So schränken Sie einen API-Schlüssel ein:

Cloud Console

1. Rufen Sie die Seite Google Maps Platform > Anmeldedaten auf.

   Zur Seite „Anmeldedaten“

2. Wählen Sie den API-Schlüssel aus, für den Sie eine Einschränkung festlegen möchten. Die Seite mit den Eigenschaften des API-Schlüssels wird angezeigt.
3. Nehmen Sie unter Schlüsseleinschränkungen folgende Einstellungen vor:
• Anwendungseinschränkungen:
1. Wenn du Anfragen von den Webserver-IP-Adressen zulassen möchtest, die du selbst bereitgestellt hast, wähle unter Anwendungseinschränkungen die Option IP-Adressen (Webserver, Cronjobs usw.) aus. Geben Sie eine oder mehrere IPv4- oder IPv6-Adressen oder Subnetze in CIDR-Notation an. Die IP-Adressen müssen mit der Quelladresse übereinstimmen, die die Google Maps Platform-Server beobachten. Wenn Sie Netzwerkadressübersetzung (Network Address Translation, NAT) einsetzen, entspricht diese Adresse in der Regel der öffentlichen IP-Adresse Ihres Computers.
• API-Einschränkungen:
1. Klicken Sie auf Schlüssel einschränken.
2. Wählen Sie im Drop-down-Menü APIs auswählen die Option Air Quality API aus. Ist die Luftqualitäts-API nicht aufgeführt, müssen Sie sie zuerst aktivieren.
4. Klicken Sie abschließend auf Speichern.
   

Cloud SDK

Listen Sie die vorhandenen Schlüssel auf.

gcloud services api-keys list --project="PROJECT"

Löschen Sie die vorhandenen Einschränkungen für einen vorhandenen Schlüssel.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Legen Sie neue Einschränkungen für den Schlüssel fest.

gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=airquality.googleapis.com
    --allowed-ips="IP_ADDRESS"

Weitere Informationen zum Google Cloud SDK, zur Cloud SDK-Installation und zu folgenden Befehlen:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

API-Schlüssel für Anfrage angeben

Für jede Air Quality API-Anfrage muss ein API-Schlüssel angegeben werden. Ersetzen Sie im folgenden Beispiel YOUR_API_KEY durch Ihren API-Schlüssel.

https://airquality.googleapis.com/v1/currentConditions:lookup?key=YOUR_API_KEY

Bei Anfragen mit API-Schlüssel ist HTTPS erforderlich.

Hinweis:Bei der Verwendung von Webdiensten müssen alle Sonderzeichen in den Parametern URL-codiert sein. URLs müssen korrekt codiert sein, um gültig zu sein. Für alle Webdienste gilt eine maximale Länge von 2.048 Zeichen. Beachten Sie diese Einschränkung beim Erstellen Ihrer URLs. Für verschiedene Browser, Proxys und Server gelten möglicherweise auch unterschiedliche URL-Zeichenbeschränkungen.