API-Schlüssel 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 findest du unter Best Practices für die API-Sicherheit.

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

  • Debug-Zertifikat: Verwenden Sie diese Art von Zertifikat 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 diese Art von 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 zum Signieren von Android-Apps und zu Zertifikaten

Die folgenden Referenzen enthalten eine Anleitung dazu, wie Sie Ihren Signaturzertifikat-Fingerabdruck finden:

  • Wenn Sie die Funktion App-Signatur von Google Play verwenden, lesen Sie den Abschnitt Working with API Providers.
  • Falls Sie Ihren eigenen Signaturschlüssel verwalten, lesen Sie den Abschnitt Anwendung selbst signieren oder folgen Sie der Anleitung für Ihre Build-Umgebung.

So schränkst du 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. Wählen Sie die Option Android-Apps aus.
      2. Klicken Sie auf + Paketname und Fingerabdruck hinzufügen.
      3. Geben Sie den Paketnamen und den SHA-1-Zertifikat-Fingerabdruck 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 Navigation SDK aus. Wenn das Navigation SDK nicht aufgeführt ist, müssen Sie es aktivieren.
  4. Klicke 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=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:

Nächste Schritte

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

Android Studio-Projekt einrichten