API-Schlüssel verwenden

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Plattform auswählen: Android iOS JavaScript

Hier erfahren Sie, wie Sie einen API-Schlüssel für das Maps SDK for Android erstellen, ihn zu Ihrer App hinzufügen und ihn einschränken, um die App sicherer zu machen. Jeder App, für die Sie das SDK verwenden, muss ein API-Schlüssel hinzugefügt werden.

Hinweis

Um das Maps SDK for Android nutzen zu können, benötigen Sie ein Projekt mit einem Rechnungskonto. Außerdem muss das Maps SDK for Android aktiviert sein. Weitere Informationen

API-Schlüssel erstellen

Der API-Schlüssel ist eine eindeutige ID. Damit werden die mit Ihrem Projekt verknüpften Anfragen zu Verwendungs- 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 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.
    Sie müssen den API-Schlüssel einschrä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 dafür gesorgt, dass nur autorisierte Anfragen gesendet werden. Weitere Informationen finden Sie unter Best Practices für die API-Sicherheit.

Wenn Sie einen API-Schlüssel einschränken, müssen Sie den Fingerabdruck des SHA-1-Zertifikats des Signaturschlüssels angeben, mit dem die App signiert wurde. Es gibt zwei Arten von Zertifikaten:

  • Debug-Zertifikat: Verwenden Sie diesen Zertifikatstyp nur mit Apps, die Sie testen, und mit Code, der nicht für die Produktionsumgebung bestimmt ist. Veröffentlichen Sie keine Apps, die mit einem Debug-Zertifikat signiert sind. Es wird von den Android SDK-Tools automatisch generiert, wenn Sie einen Debug-Build ausführen.
  • Release-Zertifikat: Verwenden Sie dieses Zertifikat, wenn Ihre App fertig für die Veröffentlichung im App-Shop ist. Es wird von den Android SDK-Tools generiert, wenn Sie einen Release-Build ausführen.

Weitere Informationen zu digitalen Zertifikaten finden Sie im Leitfaden zum Signieren von Apps (in englischer Sprache).

Weitere Informationen zum Abrufen des Fingerabdrucks des Zertifikats finden Sie unter Client authentifizieren (in englischer Sprache). Wenn Sie stattdessen die Funktion Play App-Signatur verwenden, müssen Sie in der Play Console die Seite für die App-Signatur aufrufen, um den Fingerabdruck Ihres Zertifikats zu erhalten.

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

Cloud Console

  1. Rufen Sie 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:
    • App-Einschränkungen:
      1. Wählen Sie die Option Android-Apps aus.
      2. Klicken Sie auf + Paketname und Fingerabdruck hinzufügen.
      3. Geben Sie den Paketnamen und den Fingerabdruck des SHA-1-Zertifikats ein. Beispiel:
        com.example.android.mapexample
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • API-Einschränkungen:
      1. Klicken Sie auf Schlüssel einschränken.
      2. Wählen Sie im Drop-down-Menü APIs auswählen die Option Maps SDK for Android aus. Wenn das Maps SDK for Android nicht aufgeführt ist, müssen Sie es aktivieren.
  4. Klicken Sie zum Schluss 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 einen vorhandenen Schlüssel fest.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api_target="maps-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

Weiteres Vorgehen

Da Sie nun einen API-Schlüssel haben, können Sie ein Projekt erstellen und konfigurieren, wie unter Android Studio-Projekt einrichten beschrieben.