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 wie beispielsweise einen Webserver.

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

Hinweis

Um die Address Validation API verwenden zu können, benötigen Sie ein Projekt mit einem Rechnungskonto. Außerdem muss die Address Validation API aktiviert sein. Wir empfehlen, mehrere Projektinhaber und Abrechnungsadministratoren einzurichten, damit immer jemand aus deinem Team die entsprechenden Aufgaben übernehmen kann. Weitere Informationen

OAuth

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

Das Google OAuth 2.0-System unterstützt beispielsweise Server-zu-Server-Interaktionen, z. B. zwischen Ihrer Anwendung und einem Google-Dienst. In diesem Szenario benötigen Sie ein Dienstkonto. Das ist ein Konto, das zu Ihrer Anwendung gehört, und nicht für einen einzelnen Endnutzer. Ihre Anwendung ruft Google APIs im Namen des Dienstkontos auf, sodass Nutzer nicht direkt beteiligt sind. Weitere Informationen zu Authentifizierungsmethoden finden Sie unter Authentifizierung bei 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 Bereich zugewiesen werden:

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

Beispiel: REST API-Aufrufe in Ihrer lokalen Entwicklungsumgebung testen

Wenn Sie die Address Validation API mit einem OAuth-Token ausprobieren möchten, aber keine Umgebung zum Generieren von Tokens eingerichtet haben, können Sie die Prozedur in diesem Abschnitt ausführen.

In diesem Beispiel wird beschrieben, wie Sie den OAuth-Token verwenden, der von Application Default Credentials (ADC) bereitgestellt wird, um den Aufruf durchzuführen. Informationen zur Verwendung von ADC zum Aufrufen von Google APIs mithilfe von Clientbibliotheken finden Sie unter Authentifizierung mit Clientbibliotheken.

Voraussetzungen

Bevor Sie eine REST-Anfrage mit ADC stellen können, verwenden Sie die Google Cloud CLI, um Anmeldedaten für ADC bereitzustellen:

  1. Erstellen Sie ein Projekt und aktivieren Sie die Abrechnung, indem Sie die Schritte unter In der Google Cloud Console einrichten ausführen, falls noch nicht geschehen.
  2. Installieren und initialisieren Sie die gcloud CLI.

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

    gcloud auth application-default login
  4. Ein Anmeldebildschirm wird angezeigt. Nach der Anmeldung werden Ihre Anmeldedaten in der lokalen Anmeldedatendatei, die von ADC verwendet wird gespeichert.

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

REST-Anfrage stellen

In diesem Beispiel übergeben Sie zwei Anfrageheader:

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 zu Anmeldedaten von Endnutzern zurückgegeben wird, die von dieser API nicht unterstützt werden, finden Sie hier weitere Informationen.