Krótkie wprowadzenie wyjaśnia, jak skonfigurować i uruchomić aplikację, która wywołuje Interfejs Google Workspace API.
Krótkie wprowadzenie do Google Workspace wykorzystuje biblioteki klienta API do obsługi niektórych szczegóły procesu uwierzytelniania i autoryzacji. Zalecamy używasz bibliotek klienta we własnych aplikacjach. W tym krótkim wprowadzeniu użyto uproszczone metody uwierzytelniania odpowiednie do testowania dla środowiska. W środowisku produkcyjnym zalecamy zapoznanie się z uwierzytelnianie i autoryzacja przed wybór danych logowania odpowiednie dla Twojej aplikacji.
Utworzysz aplikację internetową w języku JavaScript, która wysyła żądania do interfejsu API Dokumentów Google.
Cele
- skonfigurować środowisko,
- Skonfiguruj sampel.
- Uruchom przykład.
Wymagania wstępne
- Node.js i npm Zainstalowano.
- Google Cloud projekt.
- konto Google;
Konfigurowanie środowiska
Aby ukończyć to krótkie wprowadzenie, skonfiguruj środowisko.
Włącz API
Zanim zaczniesz korzystać z interfejsów API Google, musisz je włączyć w projekcie Google Cloud. W jednym projekcie Google Cloud możesz włączyć 1 lub więcej interfejsów API.W konsoli Google Cloud włącz interfejs Google Document API.
Konfigurowanie ekranu zgody OAuth
Jeśli korzystasz z nowego projektu Google Cloud, skonfiguruj ekranu zgody OAuth i dodaj siebie jako użytkownika testowego. Jeśli masz już konto Google ten krok został wykonany w Twoim projekcie Cloud, przejdź do następnej sekcji.
- W konsoli Google Cloud otwórz menu > Interfejsy API i Usługi > Ekran zgody OAuth. .
- Jako Typ użytkownika wybierz Wewnętrzny i kliknij Utwórz.
- Wypełnij formularz rejestracji aplikacji, a potem kliknij Zapisz i kontynuuj.
Na razie możesz pominąć dodawanie zakresów i kliknąć Zapisz i kontynuuj. w przyszłości, gdy utworzysz aplikację do użytku poza swoim Google Workspace, musisz zmienić Typ użytkownika na Zewnętrzny, a następnie: dodaj zakresy autoryzacji wymagane przez aplikację.
- Przejrzyj podsumowanie rejestracji aplikacji. Aby wprowadzić zmiany, kliknij Edytuj. Jeśli aplikacja z rejestracji wszystko jest w porządku, kliknij Back to Dashboard (Powrót do panelu).
Autoryzacja danych logowania w aplikacji internetowej
Aby uwierzytelniać użytkowników i uzyskiwać dostęp do ich danych w aplikacji, musisz: utwórz co najmniej jeden identyfikator klienta OAuth 2.0. Identyfikator klienta służy do identyfikowania z jedną aplikacją na serwery OAuth Google. Jeśli Twoja aplikacja działa na wielu platformach, musisz utworzyć oddzielny identyfikator klienta dla każdej platformy.- W konsoli Google Cloud otwórz Menu > Interfejsy API i Usługi > Dane logowania.
- Kliknij Utwórz dane logowania > Identyfikator klienta OAuth.
- Kliknij Typ aplikacji > Aplikacja internetowa.
- W polu Nazwa wpisz nazwę danych logowania. Ta nazwa jest wyświetlana tylko w konsoli Google Cloud.
- Dodaj autoryzowane identyfikatory URI powiązane z Twoją aplikacją:
- Aplikacje po stronie klienta (JavaScript) – w sekcji Autoryzowane źródła JavaScript kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI, którego chcesz używać w przypadku żądań przeglądarki. Identyfikuje domeny, z których aplikacja może wysyłać żądania interfejsu API do serwera OAuth 2.0.
- Aplikacje po stronie serwera (Java, Python i inne) – w sekcji Autoryzowane identyfikatory URI przekierowania kliknij Dodaj identyfikator URI. Następnie wpisz identyfikator URI punktu końcowego, do którego serwer OAuth 2.0 może wysyłać odpowiedzi.
- Kliknij Utwórz. Pojawi się ekran tworzenia klienta OAuth z nowym identyfikatorem klienta i tajnym kluczem klienta.
Zapisz identyfikator klienta. Tajne klucze klienta nie są używane w aplikacjach internetowych.
- Kliknij OK. Nowo utworzone dane logowania pojawią się w sekcji Identyfikatory klienta OAuth 2.0.
Zanotuj te dane logowania, ponieważ będą potrzebne w dalszej części tego krótkiego wprowadzenia.
Tworzenie klucza interfejsu API
- W konsoli Google Cloud otwórz menu > Interfejsy API i Usługi > Dane logowania. .
- Kliknij Utwórz dane logowania >. Klucz interfejsu API.
- Wyświetli się Twój nowy klucz interfejsu API.
- Kliknij Kopiuj . aby skopiować klucz interfejsu API i użyć go w kodzie aplikacji. Kluczem interfejsu API może być również w „kluczach interfejsu API” danych logowania do projektu.
- Kliknij Ogranicz klucz, aby zaktualizować ustawienia zaawansowane i ograniczyć korzystanie z klucza swojego klucza interfejsu API. Więcej informacji znajdziesz w artykule Stosowanie ograniczeń dotyczących kluczy interfejsu API.
Konfigurowanie próbki
- W katalogu roboczym utwórz plik o nazwie
index.html
. W pliku
index.html
wklej ten przykładowy kod:Zastąp następujące elementy:
YOUR_CLIENT_ID
: identyfikator klienta utworzony przez Ciebie. gdy autoryzowane dane logowania dla aplikacji internetowej.YOUR_API_KEY
: klucz interfejsu API utworzony przez Ciebie jako warunek wstępny.
Uruchamianie przykładu
W katalogu roboczym zainstaluj pakiet http-server:
npm install http-server
W katalogu roboczym uruchom serwer WWW:
npx http-server -p 8000
- W przeglądarce otwórz stronę
http://localhost:8000
. -
Pojawi się prośba o autoryzację dostępu:
- Jeśli wyświetli się prośba o zalogowanie się na konto Google, zaloguj się. Jeśli używasz wielu kont, wybierz jedno konto do autoryzacji.
- Kliknij Accept (Zaakceptuj).
Aplikacja w języku JavaScript zostanie uruchomiona i wywoła interfejs API Dokumentów Google.
Dalsze kroki
- Rozwiązywanie problemów z uwierzytelnianiem i autoryzacją
- Dokumentacja interfejsu Document API
- Sekcja
google-api-javascript-client
na GitHubie