Użyj protokołu OAuth

Interfejs Address Validation API obsługuje używanie protokołu OAuth 2.0 do uwierzytelniania. Google obsługuje typowe scenariusze korzystania z protokołu OAuth 2.0, takie jak serwer internetowy.

Ten dokument wyjaśnia, jak w środowisku programistycznym przekazać token OAuth do wywołania interfejsu Address Validation API. Instrukcje dotyczące korzystania z protokołu OAuth w środowisku produkcyjnym znajdziesz w artykule Uwierzytelnianie w Google.

Uwaga: interfejsów Map Google możesz używać bezpośrednio, wysyłając żądania interfejsu API do serwera, ale biblioteki klienta zapewniają uproszczenia, które znacznie zmniejszają ilość kodu, który musisz napisać. Mapy Google udostępniają biblioteki klienta dla wielu języków programowania, m.in. Go, Java, Node.js i Python.

Dokumentację i przykłady znajdziesz w bibliotekach klienta interfejsu Address Validation API.

Zanim zaczniesz

Zanim zaczniesz korzystać z interfejsu Address Validation API, musisz mieć projekt z włączonym kontem rozliczeniowym i interfejsem Address Validation API. Zalecamy utworzenie kilku właścicieli projektu i administratorów rozliczeń, aby zawsze mieć w zespole osoby pełniące te role. Więcej informacji znajdziesz w artykule Konfigurowanie w konsoli Cloud Console.

Informacje o protokole OAuth

W zależności od środowiska wdrożenia możesz tworzyć tokeny dostępu OAuth i nimi zarządzać na wiele sposobów.

Na przykład system Google OAuth 2.0 obsługuje interakcje między serwerami, na przykład między aplikacją a usługą Google. W tym scenariuszu potrzebujesz konta usługi, które należy do Twojej aplikacji, a nie do użytkownika. Aplikacja wywołuje interfejsy API Google w imieniu konta usługi, więc użytkownicy nie biorą bezpośrednio udziału w tym procesie. Więcej informacji o metodach uwierzytelniania znajdziesz w artykule Uwierzytelnianie w Google.

Możesz też używać interfejsu Address Validation API w ramach aplikacji mobilnej na Androida lub iOS. Ogólne informacje o używaniu OAuth z interfejsem Address Validation API, w tym o zarządzaniu tokenami dostępu w różnych środowiskach wdrożenia, znajdziesz w artykule Korzystanie z protokołu OAuth 2.0 do uzyskiwania dostępu do interfejsów API Google.

Zakresy protokołu OAuth

Aby używać OAuth z interfejsem Address Validation API, tokenowi OAuth musi zostać przypisany zakres:

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

Przykład: wypróbuj wywołania interfejsu REST API w lokalnym środowisku programistycznym

Jeśli chcesz wypróbować interfejs Address Validation API za pomocą tokena OAuth, ale nie masz skonfigurowanego środowiska do generowania tokenów, możesz wykonać to wywołanie, korzystając z procedury opisanej w tej sekcji.

W tym przykładzie opisujemy, jak użyć tokena OAuth udostępnionego przez domyślne dane logowania aplikacji (ADC) do wywołania interfejsu. Informacje o używaniu usługi ADC do wywoływania interfejsów API Google za pomocą bibliotek klienta znajdziesz w artykule Uwierzytelnianie za pomocą bibliotek klienta.

Uwaga: opisana poniżej procedura wywoływania interfejsu REST nie jest przeznaczona do użytku w środowisku produkcyjnym. Stosuj tę procedurę tylko w środowisku programistycznym lub testowym.

Wymagania wstępne

Zanim będzie można wysłać żądanie REST za pomocą ADC, należy użyć interfejsu wiersza poleceń Google Cloud, aby podać dane logowania do ADC:

1. Jeśli nie masz jeszcze utworzonego projektu, utwórz go i włącz płatności, wykonując czynności opisane w artykule Konfigurowanie w konsoli Google Cloud.
2. Zainstaluj i zainicjuj interfejs wiersza poleceń gcloud.

3. Aby utworzyć plik z danymi logowania, na komputerze lokalnym uruchom to polecenie gcloud:

   gcloud auth application-default login

4. Wyświetli się ekran logowania. Po zalogowaniu się Twoje dane logowania są przechowywane w lokalnym pliku z danymi logowania używanym przez ADC.

Więcej informacji znajdziesz w sekcji Lokalne środowisko programistyczne w dokumentacji Podawanie danych logowania do domyślnych danych logowania aplikacji.

Przesyłanie żądania REST

W tym przykładzie przekazujesz 2 nagłówki żądania:

• Przekaż token OAuth w nagłówku Authorization, generując go za pomocą tego polecenia:

  gcloud auth application-default print-access-token

  Zwrócony token ma zakres https://www.googleapis.com/auth/cloud-platform.

• Przekaż w nagłówku X-Goog-User-Project identyfikator lub nazwę projektu Google Cloud, w którym włączone są płatności. Więcej informacji znajdziesz w artykule Konfigurowanie w konsoli Cloud.

W tym przykładzie wywołujemy interfejs Address Validation API za pomocą tokena OAuth:

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"

Rozwiązywanie problemów

Jeśli żądanie zwróci komunikat o błędzie informujący, że dane logowania użytkownika nie są obsługiwane przez to API, zapoznaj się z artykułem Dane logowania użytkownika nie działają.