Konfigurowanie pakietu JavaScript Consumer SDK

Dzięki pakietowi JavaScript Consumer SDK Twoja aplikacja dla konsumentów może wyświetlać na mapie internetowej lokalizację pojazdów i innych miejsc zainteresowania śledzonych w Fleet Engine. Dzięki temu klienci mogą śledzić postępy dostawy. W tym przewodniku przyjęto założenie, że masz skonfigurowaną usługę Fleet Engine z projektu Google Cloud i kluczy interfejsu API. Więcej informacji znajdziesz w Fleet Engine.

Aby skonfigurować JavaScript Consumer SDK, wykonaj te czynności:

  1. Włącz Maps JavaScript API.
  2. Skonfiguruj autoryzację.

Włączanie interfejsu Maps JavaScript API

Włącz interfejs Maps JavaScript API w projekcie konsoli Google Cloud, którego używasz do instancji Fleet Engine. Więcej informacji znajdziesz w sekcji Włączanie interfejsów API w dokumentacji interfejsu Maps JavaScript API.

Autoryzacja konfiguracji

W przypadku wywołań metod interfejsu API z środowisk o niskim poziomie zaufania usługa Fleet Engine wymaga korzystania z tokenów sieciowych JSON (JWT) podpisanych odpowiednim kontem usługi. Środowiska o niskim stopniu zaufania to m.in. smartfony i przeglądarki. Token JWT pochodzi z serwera, który jest pełnowymiarowym zaufanym środowiskiem. Token JWT jest podpisany, zaszyfrowany i przekazywany do klienta w celu kolejnego serwera. do momentu ich wygaśnięcia lub utraty ważności.

Twój backend powinien uwierzytelniać się i autoryzować we Fleet Engine za pomocą standardowych domyślnych danych logowania aplikacji. Marka używaj tokenów JWT, które zostały podpisane przez odpowiednie konto usługi. Listę ról kont usług znajdziesz w artykule Podstawy Fleet Engine, w sekcji Role kont usług Fleet Engine.

Aplikacja dla klientów indywidualnych powinna uwierzytelniać użytkowników za pomocą delivery_consumer rola z projektu Google Cloud, która zostanie zwrócona tylko konsumentom. W ten sposób Fleet Engine filtruje i usuwa wszystkie inne informacje w odpowiedziach. Na przykład podczas zadania dotyczącego niedostępności Dane o lokalizacji nie są udostępniane użytkownikowi. Zobacz konto usługi ról dla zaplanowanych zadań.

Z kolei backend powinien uwierzytelniać i autoryzować się w ramach Fleet Engine, korzystając ze standardowych mechanizmów danych uwierzytelniających aplikacji.

Jak działa autoryzacja?

Autoryzacja za pomocą danych Fleet Engine wymaga implementacji po stronie serwera i po stronie klienta.

Autoryzacja po stronie serwera

Przed skonfigurowaniem uwierzytelniania i autoryzacji w aplikacji internetowej aplikacji, serwer backendu musi mieć możliwość wystawiania tokenów sieciowych JSON w aplikacja internetowa zapewniająca dostęp do Fleet Engine. Twoja aplikacja internetowa wysyła te tokeny JWT z żądaniami, aby usługa Fleet Engine uznała je za uwierzytelnione i upoważnione do dostępu do danych w żądaniu. Instrukcje dotyczące implementacji JWT po stronie serwera znajdziesz w sekcji Najważniejsze informacje o Fleet Engine Wydawanie tokenów sieciowych JSON.

W szczególności w przypadku pakietu SDK JavaScript Consumer do śledzenia przesyłek należy pamiętać o tych kwestiach:

Autoryzacja po stronie klienta

Gdy używasz pakietu JavaScript Consumer SDK, wysyła on żądanie tokena do serwera za pomocą modułu pobierania tokena autoryzacji. Dzieje się tak, gdy jest spełniony co najmniej jeden z tych warunków:

  • Brak prawidłowego tokena, na przykład jeśli pakiet SDK nie wywołał modułu pobierania na wczytanie nowej strony lub gdy moduł pobierania nie zwrócił się z tokenem.

  • Token wygasł.

  • Token wygaśnie w ciągu minuty.

W przeciwnym razie JavaScript Consumer SDK używa wcześniej wydanego, prawidłowego tokena i nie możesz wywołać moduł pobierania.

Tworzenie modułu pobierania tokenów autoryzacji

Aby utworzyć funkcję pobierania tokenu autoryzacyjnego, postępuj zgodnie z tymi wskazówkami:

  • Moduł pobierania musi zwrócić strukturę danych z 2 polami opakowaną w Promise w następujący sposób:

    • Ciąg token.

    • Numer expiresInSeconds. Token wygasa po tym czasie po pobraniu. Moduł pobierania tokenów uwierzytelniania musi utracić ważność czas w sekundach, od momentu pobrania do biblioteki, jak widać w z przykładu.

  • Aby pobrać token, pobieracz powinien wywołać adres URL na Twoim serwerze. Ten Adres URL (SERVER_TOKEN_URL) zależy od implementacji backendu. ten przykładowy URL dotyczy backendu przykładowej aplikacji na GitHubie:

    • https://SERVER_URL/token/delivery_consumer/TRACKING_ID

Przykład – tworzenie modułu pobierania tokenów uwierzytelniania

Te przykłady pokazują, jak utworzyć funkcję pobierania tokena autoryzacji:

JavaScript

async function authTokenFetcher(options) {
  // options is a record containing two keys called
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.Token,
    expiresInSeconds: data.ExpiresInSeconds
  };
}

TypeScript

function authTokenFetcher(options: {
  serviceType: google.maps.journeySharing.FleetEngineServiceType,
  context: google.maps.journeySharing.AuthTokenContext,
}): Promise<google.maps.journeySharing.AuthToken> {
  // The developer should generate the correct
  // SERVER_TOKEN_URL based on options.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.token,
    expiresInSeconds: data.ExpiresInSeconds,
  };
}

Co dalej?