OAuth verwenden

Die Address Validation API unterstützt die Verwendung von OAuth 2.0 zur Authentifizierung. Google unterstützt gängige OAuth 2.0-Szenarien, z. B. für einen Webserver.

In diesem Dokument wird beschrieben, wie Sie ein OAuth-Token an den Address Validation API-Aufruf in Ihrer Entwicklungsumgebung übergeben. Eine Anleitung zur Verwendung von OAuth in einer Produktionsumgebung finden Sie unter Authentifizierung bei Google.

Hinweis : Sie können Google Maps APIs zwar direkt verwenden, indem Sie API-Anfragen an den Server senden, aber Clientbibliotheken bieten Vereinfachungen, mit denen Sie den zu schreibenden Code erheblich reduzieren müssen. Google Maps bietet Clientbibliotheken für viele Programmiersprachen, darunter Go, Java, Node.js und Python.

Eine Dokumentation und Beispiele finden Sie unter Address Validation API-Clientbibliotheken.

Hinweis

Bevor Sie die Address Validation API verwenden können, benötigen Sie ein Projekt mit einem Rechnungskonto. Außerdem muss die Address Validation API aktiviert sein. Wir empfehlen, mehrere Project Owners und Billing Administrators einzurichten, damit immer jemand aus Ihrem Team die entsprechenden Aufgaben übernehmen kann. Weitere Informationen

Informationen zu OAuth

Es gibt je nach Ihrer Bereitstellungsumgebung viele Möglichkeiten, Zugriffstokens mit OAuth zu erstellen und zu verwalten.

Das OAuth 2.0-System von Google unterstützt beispielsweise Server-zu-Server-Interaktionen, z. B. zwischen Ihrer Anwendung und einem Google-Dienst. Für dieses Szenario benötigen Sie ein Dienstkonto. Das ist ein Konto, das Ihrer Anwendung und nicht einem bestimmten Endnutzer gehört. Ihre Anwendung ruft Google APIs im Namen des Dienstkontos auf, sodass Nutzer nicht direkt beteiligt sind. Weitere Informationen zu Authentifizierungsmethoden finden Sie unter Authentifizierung mit Google.

Alternativ können Sie die Address Validation API als Teil einer mobilen Android- oder iOS-App verwenden. Allgemeine Informationen zur Verwendung von OAuth mit der Address Validation API, einschließlich Informationen zum Verwalten von Zugriffstokens für verschiedene Bereitstellungsumgebungen, finden Sie unter OAuth 2.0 für den Zugriff auf Google APIs verwenden.

OAuth-Bereiche

Wenn Sie OAuth mit der Address Validation API verwenden möchten, muss dem OAuth-Token der folgende Bereich zugewiesen werden:

• https://www.googleapis.com/auth/cloud-platform

Beispiel: REST API-Aufrufe in der lokalen Entwicklungsumgebung testen

Wenn Sie die Address Validation API mit einem OAuth-Token testen möchten, aber keine Umgebung zum Generieren von Tokens eingerichtet haben, können Sie das Verfahren in diesem Abschnitt für den Aufruf verwenden.

In diesem Beispiel wird beschrieben, wie Sie das von den Standardanmeldedaten für Anwendungen bereitgestellte OAuth-Token für den Aufruf verwenden. Informationen zur Verwendung von ADC für den Aufruf von Google APIs mithilfe von Clientbibliotheken findest du unter Mit Clientbibliotheken authentifizieren.

Hinweis: Das folgende Verfahren zum Ausführen eines REST-Aufrufs ist nicht für die Verwendung in einer Produktionsumgebung vorgesehen. Verwenden Sie dieses Verfahren nur für eine Entwicklungs- oder Testumgebung.

Voraussetzungen

Bevor Sie eine REST-Anfrage mit ADC stellen können, müssen Sie über die Google Cloud CLI Anmeldedaten für ADC bereitstellen:

1. Falls noch nicht geschehen, erstellen Sie ein Projekt und aktivieren Sie die Abrechnung. Folgen Sie dazu der Anleitung unter Google Cloud Console einrichten.
2. Installieren und initialisieren Sie die gcloud CLI.

3. Führen Sie den folgenden gcloud-Befehl auf Ihrem lokalen Computer aus, um die Datei mit den Anmeldedaten zu erstellen:

   gcloud auth application-default login

4. Ein Anmeldebildschirm wird angezeigt. Nach der Anmeldung werden Ihre Anmeldedaten in der von ADC verwendeten lokalen Datei mit Anmeldedaten gespeichert.

Weitere Informationen finden Sie im Abschnitt Lokale Entwicklungsumgebung der Dokumentation Anmeldedaten für Standardanmeldedaten für Anwendungen angeben.

REST-Anfrage stellen

In diesem Beispiel übergeben Sie zwei Anfrageheader:

• Übergeben Sie das OAuth-Token im Authorization-Header mit dem folgenden Befehl, um das Token zu generieren:

  gcloud auth application-default print-access-token

  Das zurückgegebene Token hat den Geltungsbereich https://www.googleapis.com/auth/cloud-platform.

• Übergeben Sie im X-Goog-User-Project-Header die ID oder den Namen des Google Cloud-Projekts, für das die Abrechnung aktiviert ist. Weitere Informationen finden Sie unter Google Cloud-Projekt einrichten.

Im folgenden Beispiel wird die Address Validation API mit einem OAuth-Token aufgerufen:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://addressvalidation.googleapis.com/v1:validateAddress"

Fehlerbehebung

Wenn in Ihrer Anfrage eine Fehlermeldung darüber zurückgegeben wird, dass Endnutzeranmeldedaten von dieser API nicht unterstützt werden, finden Sie weitere Informationen unter Nutzeranmeldedaten funktionieren nicht.