Übersicht zu API-Schlüsseln

Ein API-Schlüssel ist ein einfacher verschlüsselter String, den Sie beim Aufrufen vonGoogle Cloud -APIs verwenden können. Ein typischer Anwendungsfall für einen API-Schlüssel ist dessen Übergabe als Abfrageparameter an einen REST API-Aufruf mit dem folgenden Format:

http://example-library.googleapis.com/v1/publishers/mypublisher/books?key=API_KEY
 API-Schlüssel sind nützlich, um anonym auf öffentliche Daten zuzugreifen, und werden verwendet, um API-Anfragen dem Google Cloud -Projekt des Nutzers für Kontingente und Abrechnung zuzuordnen.

Mit API Keys erhalten Sie eine programmatische Schnittstelle zum Erstellen und Verwalten von API-Schlüsseln für Ihr Projekt. Sie haben damit mehr Kontrolle über API-Schlüssel als mit den API-Schlüssel-bezogenen Aufgaben, die Sie in der Google Cloud Console ausführen können.

Weitere Informationen zur Authentifizierung bei Google Cloud APIs und zur Ermittlung der besten Authentifizierungsstrategie für häufige Szenarien finden Sie in der Übersicht zur Authentifizierung. Weitere Informationen zu API-Schlüsseln für Google Maps Platform APIs und SDKs finden Sie in der Google Maps Platform-Dokumentation.

API-Schlüssel sichern

Wenn Sie API-Schlüssel in Ihren Anwendungen verwenden, achten Sie darauf, dass sie sowohl beim Speichern als auch bei der Übertragung sicher sind. Wenn Sie Ihre Anmeldedaten öffentlich preisgeben, gefährden Sie damit möglicherweise Ihr Konto, was zu unerwarteten Kosten führen könnte. Sie sollten diese Best Practices befolgen, um die Sicherheit Ihrer API-Schlüssel zu wahren:

  • Betten Sie API-Schlüssel nicht direkt in Code ein. In Code eingebettete API-Schlüssel können versehentlich öffentlich zugänglich gemacht werden. Dies kann beispielsweise geschehen, wenn Sie vergessen, die Schlüssel aus freigegebenem Code zu entfernen. Anstatt Ihre API-Schlüssel in Ihre Anwendungen einzubetten, sollten Sie sie in Umgebungsvariablen oder Dateien außerhalb der Quellstruktur der Anwendung speichern.

  • Einschränkungen für den API-Schlüssel hinzufügen Dadurch können Sie die Auswirkungen eines eventuell manipulierten API-Schlüssels reduzieren.

  • Löschen Sie nicht benötigte API-Schlüssel, um das Angriffsrisiko zu minimieren.

  • Rotieren Sie Ihre API-Schlüssel regelmäßig. Wenn Sie Ihre API-Schlüssel rotieren möchten, rufen Sie die Methode CreateKey auf. Nachdem die Ersatzschlüssel erstellt wurden, aktualisieren Sie Ihre Anwendungen, damit sie die neu generierten Schlüssel verwenden, und löschen Sie die alten Schlüssel.

  • Überprüfen Sie Ihren Code, bevor Sie ihn veröffentlichen. Er sollte keine API-Schlüssel oder andere private Informationen enthalten.

Nächste Schritte