JavaScript Consumer SDK einrichten

Mit dem JavaScript Consumer SDK kann Ihre Verbraucher-App den Standort von Fahrzeugen und anderen in Fleet Engine erfassten Orten von Interesse auf einer webbasierten Karte anzeigen. So können Ihre Nutzer den Fortschritt ihrer Sendungen verfolgen. In dieser Anleitung wird davon ausgegangen, dass Sie Fleet Engine mit dem zugehörigen Google Cloud-Projekt und den API-Schlüsseln eingerichtet haben. Weitere Informationen finden Sie unter Fleet Engine.

So richten Sie das JavaScript Consumer SDK ein:

  1. Aktivieren Sie die Maps JavaScript API.
  2. Richten Sie die Autorisierung ein.

Maps JavaScript API aktivieren

Aktivieren Sie die Maps JavaScript API in dem Google Cloud Console-Projekt, das Sie für Ihre Fleet Engine-Instanz verwenden. Weitere Informationen finden Sie in der Dokumentation zur Maps JavaScript API unter APIs aktivieren.

Autorisierung einrichten

Für API-Methodenaufrufe aus Umgebungen mit geringem Vertrauen erfordert die Fleet Engine die Verwendung von JSON Web Tokens (JWTs), die von einem geeigneten Dienstkonto signiert wurden. Zu den Umgebungen mit wenig Vertrauen gehören Smartphones und Browser. Ein JWT stammt von Ihrem Server, einer vollständig vertrauenswürdigen Umgebung. Das JWT wird signiert, verschlüsselt und für nachfolgende Serverinteraktionen an den Client übergeben, bis es abläuft oder nicht mehr gültig ist.

Ihr Backend sollte sich mithilfe der standardmäßigen Standardanmeldedaten für Anwendungen bei der Fleet Engine authentifizieren und autorisieren. Verwenden Sie JWTs, die von einem entsprechenden Dienstkonto signiert wurden. Eine Liste der Dienstkontorollen finden Sie unter Fleet Engine-Dienstkontorollen in Fleet Engine-Grundlagen.

Ihre Verbraucher-App sollte Ihre Endnutzer mit der Rolle delivery_consumer aus Ihrem Google Cloud-Projekt authentifizieren, um nur nutzerspezifische Informationen zurückzugeben. So filtert und entfernt Fleet Engine alle anderen Informationen in den Antworten. Bei einer Nichtverfügbarkeitsaufgabe werden beispielsweise keine Standortinformationen an einen Endnutzer weitergegeben. Informationen zu geplanten Aufgaben finden Sie unter Rollen für Dienstkonten.

Ihr Backend sollte sich dagegen mithilfe der standardmäßigen Standardanmeldedaten für Anwendungen bei der Fleet Engine authentifizieren und autorisieren.

Wie funktioniert die Autorisierung?

Die Autorisierung mit Fleet Engine-Daten umfasst sowohl die serverseitige als auch die clientseitige Implementierung.

Serverseitige Autorisierung

Bevor Sie die Authentifizierung und Autorisierung in Ihrer webbasierten Anwendung einrichten, muss Ihr Back-End-Server JSON-Webtokens für Ihre webbasierte Anwendung ausstellen können, um auf die Fleet Engine zuzugreifen. Ihre webbasierte Anwendung sendet diese JWTs mit ihren Anfragen, damit die Fleet Engine die Anfragen als authentifiziert und autorisiert für den Zugriff auf die Daten in der Anfrage erkennt. Eine Anleitung zur serverseitigen JWT-Implementierung finden Sie unter Fleet Engine Essentials im Abschnitt JSON Web Tokens ausstellen.

Beachten Sie insbesondere Folgendes für das JavaScript Consumer SDK zum Sendungs-Tracking:

Clientseitige Autorisierung

Wenn Sie das JavaScript Consumer SDK verwenden, wird über einen Autorisierungstoken-Abruf ein Token vom Server angefordert. Dies geschieht in folgenden Fällen:

  • Es ist kein gültiges Token vorhanden, beispielsweise wenn das SDK den Fetcher beim erneuten Laden der Seite nicht aufgerufen hat oder wenn der Fetcher kein Token zurückgegeben hat.

  • Das Token ist abgelaufen.

  • Das Token läuft in weniger als einer Minute ab.

Andernfalls verwendet das JavaScript Consumer SDK das zuvor ausgestellte, gültige Token und ruft den Fetcher nicht auf.

Abrufmechanismus für Autorisierungstoken erstellen

Erstelle den Abrufmechanismus für Autorisierungstokens unter Berücksichtigung der folgenden Richtlinien:

  • Der Abruf muss eine Datenstruktur mit zwei Feldern zurückgeben, die wie unten dargestellt in einer Promise verpackt ist:

    • Einen String token.

    • Eine Zahl expiresInSeconds. Ein Token läuft nach dem Abrufen nach dieser Zeit ab. Der Abrufmechanismus für das Authentifizierungstoken muss die Ablaufzeit in Sekunden vom Abruf bis zur Bibliothek übergeben, wie im Beispiel gezeigt.

  • Der Fetcher sollte eine URL auf Ihrem Server aufrufen, um ein Token abzurufen. Diese URL (SERVER_TOKEN_URL) hängt von Ihrer Backend-Implementierung ab. Die folgende Beispiel-URL bezieht sich auf das Backend der Beispielanwendung auf GitHub:

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

Beispiel – Abruf eines Authentifizierungstokens erstellen

Die folgenden Beispiele zeigen, wie Sie einen Abrufmechanismus für Autorisierungstokens erstellen:

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,
  };
}

Nächste Schritte