API-Schlüssel mit Solar 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 erfahren Sie, wie Sie einen API-Schlüssel für die Google Maps Platform erstellen, einschränken und verwenden.

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:

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.

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. Um Anfragen aus der Liste der von Ihnen angegebenen Webserver-IP-Adressen zu akzeptieren, wählen Sie IP-Adressen (Webserver, Cronjobs usw.) aus der Liste der Anwendungseinschränkungen: Geben Sie eine oder mehrere IPv4- oder IPv6-Adressen an, oder Subnetz in CIDR-Notation. Die IP-Adressen müssen mit der Quelladresse übereinstimmen, Google Maps Platform-Server beobachten. Wenn Sie Netzwerk Address Translation (NAT) Dies entspricht in der Regel der öffentlichen IP-Adresse Ihres Computers.
    • API-Einschränkungen:
      1. Klicken Sie auf Schlüssel einschränken.
      2. Wähle im Drop-down-Menü APIs auswählen die Option Solar API aus. Wenn die Solar API nicht aufgeführt ist, müssen Sie 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/keys/KEY_ID" \
    --api-target="solar.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

API-Schlüssel für Anfrage angeben

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

https://solar.googleapis.com/v1/buildingInsights:findClosest?location.latitude=37.2746464&location.longitude=-121.7530949&key=YOUR_API_KEY

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