Configurer la bibliothèque de suivi de parc JavaScript

Avant d'utiliser la bibliothèque de suivi de parc JavaScript, assurez-vous de connaître et d'avoir configuré Fleet Engine. Pour en savoir plus, consultez Fleet Engine.

Ce document explique comment activer l'autorisation entre l'application de la page Web et Fleet Engine. Une fois que vos requêtes adressées à Fleet Engine ont été configurées avec les jetons d'autorisation appropriés, vous pouvez suivre un véhicule sur une carte.

Configurer les autorisations

Fleet Engine nécessite l'utilisation de jetons Web JSON (JWT) pour les appels de méthode API à partir d'environnements à faible niveau de confiance : smartphones et navigateurs.

Un jeton JWT est généré sur votre serveur, signé, chiffré et transmis au client pour les interactions ultérieures avec le serveur jusqu'à ce qu'il expire ou ne soit plus valide.

Informations essentielles

Comment fonctionne l'autorisation ?

L'autorisation avec les données Fleet Engine implique une implémentation côté serveur et côté client.

Autorisation côté serveur

Avant de configurer l'authentification et l'autorisation dans votre application de suivi de parc, votre serveur backend doit pouvoir émettre des jetons Web JSON pour votre application de suivi de parc afin d'accéder à Fleet Engine. Votre application de suivi de parc envoie ces jetons JWT avec ses requêtes afin que Fleet Engine les reconnaisse comme authentifiées et autorisées à accéder aux données de la requête. Pour obtenir des instructions sur l'implémentation des jetons JWT côté serveur, consultez la section Émettre des jetons Web JSON sous Principes de base de Fleet Engine.

Pour générer des jetons à partir de votre serveur lors de l'implémentation du suivi de parc, consultez les ressources suivantes :

Autorisation côté client

Lorsque vous utilisez la bibliothèque de suivi de parc JavaScript, elle demande un jeton au serveur à l'aide d'un récupérateur de jetons d'autorisation. Cela se produit lorsque l'une des conditions suivantes est remplie :

  • Aucun jeton valide n'existe, par exemple lorsque le SDK n'a pas appelé le récupérateur lors d'un nouveau chargement de page ou lorsque le récupérateur n'a pas renvoyé de jeton.

  • Le jeton est arrivé à expiration.

  • Le jeton expire dans moins d'une minute.

Sinon, la bibliothèque de suivi de parc JavaScript utilise le jeton valide émis précédemment et n'appelle pas le récupérateur.

Créer un récupérateur de jetons d'autorisation

Créez votre récupérateur de jetons d'autorisation en suivant ces consignes :

  • Le récupérateur doit renvoyer une structure de données avec deux champs, encapsulés dans un Promise comme suit :

    • Une chaîne token.

    • Un nombre expiresInSeconds. Un jeton expire après ce délai après la récupération. Le récupérateur de jetons d'authentification doit transmettre le délai d'expiration en secondes, entre le moment de la récupération et la bibliothèque, comme illustré dans l'exemple.

  • Le récupérateur doit appeler une URL sur votre serveur pour récupérer un jeton. Cette URL, SERVER_TOKEN_URL, dépend de votre implémentation backend. L'exemple d'URL suivant concerne le backend de l'exemple d'application sur GitHub :

    • https://SERVER_URL/token/fleet_reader

Exemple : Créer un récupérateur de jetons d'autorisation

Les exemples suivants montrent comment créer un récupérateur de jetons d'autorisation :

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

Étape suivante