Interfejs Pollen 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.
Z tego dokumentu dowiesz się, jak przekazać token OAuth do wywołania interfejsu Pollen API w środowisku rozwoju. Instrukcje dotyczące korzystania z protokołu OAuth w środowisku produkcyjnym znajdziesz w artykule Uwierzytelnianie w Google.
Zanim zaczniesz
Zanim zaczniesz korzystać z interfejsu Pollen API, musisz mieć projekt z kontem rozliczeniowym i włączonym interfejsem Pollen 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 Pollen API w ramach aplikacji mobilnej na Androida lub iOS. Ogólne informacje o używaniu OAuth z interfejsem Pollen API, w tym o zarządzaniu tokenami dostępu w różnych środowiskach wdrożeniowych, znajdziesz w artykule Uzyskiwanie dostępu do interfejsów API Google za pomocą protokołu OAuth 2.0.
Zakresy protokołu OAuth
Aby korzystać z OAuth w Pollen API, tokenowi OAuth należy przypisać 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 Pollen API za pomocą tokena OAuth, ale nie masz skonfigurowanego środowiska do generowania tokenów, możesz wykonać tę procedurę, aby wykonać wywołanie.
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.
Wymagania wstępne
Zanim użyjesz żądania REST za pomocą ADC, użyj interfejsu wiersza poleceń Google Cloud, aby podać dane logowania do ADC:
- 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.
- Zainstaluj i zainicjuj interfejs wiersza poleceń gcloud.
Aby utworzyć plik danych logowania, na komputerze lokalnym uruchom to polecenie
gcloud:gcloud auth application-default login
- 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-tokenZwrócony token ma zakres
https://www.googleapis.com/auth/cloud-platform.- Przekaż w nagłówku
X-Goog-User-Projectidentyfikator 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 Pollen API za pomocą tokena OAuth:
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" -H "X-Goog-User-Project: PROJECT_ID" -d '{ "location": { "latitude": 32.62782385865436, "longitude": 35.02197334774893 } }' "https://pollen.googleapis.com/v1/forecast:lookup"
Rozwiązywanie problemów
Jeśli żądanie zwróci komunikat o błędzie, że dane logowania użytkownika nie są obsługiwane przez to API, zapoznaj się z artykułem Dane logowania użytkownika nie działają.