API-Schlüssel verwenden

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 zu sichern. Du musst jeder App, für die du das SDK verwendest, einen API-Schlüssel hinzufügen.

Hinweis

Damit du das Maps SDK for Android nutzen kannst, benötigst du ein Projekt mit einem Rechnungskonto. Außerdem muss das Maps SDK for Android aktiviert sein. Weitere Informationen findest du im englischsprachigen Artikel zum Einrichten von Projekten in der Google Cloud Console.

API-Schlüssel erstellen

Der API-Schlüssel ist eine eindeutige Kennung, mit der Anfragen deines Projekts zu Nutzungs- und Abrechnungszwecken authentifiziert werden. Sie müssen mindestens einen API-Schlüssel mit Ihrem Projekt verknüpft haben.

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

Wenn du API-Schlüssel einschränkst, wird deine App sicherer und es wird dafür gesorgt, dass nur autorisierte Anfragen gesendet werden. Wir empfehlen dringend, die Einschränkungen für deine API-Schlüssel zu befolgen. Weitere Informationen findest du unter Best Practices für die API-Sicherheit.

Wenn du den API-Schlüssel einschränkst, musst du den SHA-1-Zertifikatfingerabdruck des Signaturschlüssels angeben, mit dem die App signiert wurde. Es gibt zwei Arten von Zertifikaten:

  • Debug-Zertifikat: Verwende diesen Zertifikatstyp nur mit Apps, die du testest, und mit Code, der nicht für die Produktionsumgebung bestimmt ist. Veröffentliche keine Apps, die mit einem Debug-Zertifikat signiert sind. Es wird von den Android SDK-Tools automatisch generiert, wenn du einen Debug-Build ausführst.
  • Release-Zertifikat: Verwende dieses Zertifikat, wenn deine App veröffentlicht werden soll. Es wird von den Android SDK-Tools generiert, wenn du einen Release-Build ausführst.

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

Weitere Informationen zum Abrufen des Zertifikatfingerabdrucks finden Sie unter Client authentifizieren. Wenn Sie 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ähle den API-Schlüssel aus, für den du eine Einschränkung festlegen möchtest. Die Seite mit den Eigenschaften des API-Schlüssels wird angezeigt.
  3. Nimm unter Schlüsseleinschränkungen folgende Einstellungen vor:
    • App-Einschränkungen:
      1. Wähle die Option Android-Apps aus.
      2. Klicke auf + Paketname und Fingerabdruck hinzufügen.
      3. Gib 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. Klicke auf Schlüssel einschränken.
      2. Wähle im Drop-down-Menü APIs auswählen die Option Maps SDK for Android aus. Wenn das Maps SDK for Android nicht aufgeführt ist, musst du es aktivieren.
  4. Klicke abschließend auf Speichern.

Cloud SDK

Vorhandene Schlüssel auflisten

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

Vorhandene Einschränkungen für einen vorhandenen Schlüssel löschen

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

Neue Einschränkungen für einen vorhandenen Schlüssel festlegen

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 Bestehendes Android Studio-Projekt einrichten beschrieben.