Configura el SDK del consumidor de JavaScript

Con el SDK para consumidores de JavaScript, tu app para consumidores puede mostrar la ubicación de los vehículos y otras ubicaciones de interés a las que se les hace un seguimiento en Fleet Engine en un mapa basado en la Web. Esto permite que los usuarios consumidores vean el progreso de sus envíos. En esta guía, se supone que configuraste Fleet Engine con su proyecto de Google Cloud y sus claves de API asociadas. Consulta Fleet Engine para obtener más detalles.

Para configurar el SDK de consumidor de JavaScript, sigue estos pasos:

  1. Habilita la API de Maps JavaScript.
  2. Configura la autorización.

Habilita la API de Maps JavaScript

Habilita la API de Maps JavaScript en el proyecto de la consola de Google Cloud que usas para tu instancia de Fleet Engine. Para obtener más detalles, consulta Habilita las APIs en la documentación de la API de Maps JavaScript.

Configura la autorización

Para las llamadas a métodos de API desde entornos de baja confianza, Fleet Engine requiere el uso de tokens web JSON (JWT) firmados por una cuenta de servicio adecuada. Los entornos de baja confianza incluyen smartphones y navegadores. Un JWT se origina en tu servidor, que es un entorno completamente confiable. El JWT se firma, encripta y pasa al cliente para interacciones posteriores con el servidor hasta que venza o ya no sea válido.

Tu backend debe autenticarse y autorizarse en Fleet Engine con los mecanismos estándar de las credenciales predeterminadas de la aplicación. Asegúrate de usar JWTs firmados por una cuenta de servicio adecuada. Para obtener una lista de los roles de las cuentas de servicio, consulta los roles de la cuenta de servicio de Fleet Engine en Conceptos básicos de Fleet Engine.

Tu app para consumidores debe autenticar a tus usuarios finales con el rol delivery_consumer de tu proyecto de Google Cloud para mostrar solo información específica del consumidor. De esta manera, Fleet Engine filtra y oculta toda la información que no sea la de la respuesta. Por ejemplo, durante una tarea de no disponibilidad, no se comparte información de ubicación con un usuario final. Consulta Roles de la cuenta de servicio para las tareas programadas.

Por el contrario, tu backend debe autenticarse y autorizarse en Fleet Engine con mecanismos estándar de credenciales predeterminadas de la aplicación.

¿Cómo funciona la autorización?

La autorización con datos de Fleet Engine implica la implementación del servidor y del cliente.

Autorización del servidor

Antes de configurar la autenticación y la autorización en tu aplicación basada en la Web, el servidor de backend debe poder emitir tokens web JSON a tu aplicación basada en la Web para acceder a Fleet Engine. Tu aplicación web envía estos JWT con sus solicitudes para que Fleet Engine las reconozca como autenticadas y autorizadas para acceder a los datos de la solicitud. Para obtener instrucciones sobre la implementación de JWT del servidor, consulta Emite tokens web JSON en Nociones básicas del motor de flota.

Específicamente, ten en cuenta lo siguiente para el SDK de consumidor de JavaScript para hacer un seguimiento de los envíos:

Autorización del cliente

Cuando usas el SDK de consumidor de JavaScript, este solicita un token al servidor con un recuperador de tokens de autorización. Esto sucede cuando se cumple una de las siguientes condiciones:

  • No existe un token válido, como cuando el SDK no llamó al recuperador en una carga de página nueva o cuando el recuperador no mostró un token.

  • El token caducó.

  • El token vencerá en un minuto.

De lo contrario, el SDK de consumidor de JavaScript usa el token válido emitido anteriormente y no llama al recuperador.

Crea un recuperador de tokens de autorización

Crea tu recuperador de tokens de autorización con estos lineamientos:

  • El recuperador debe mostrar una estructura de datos con dos campos, unidos en un Promise de la siguiente manera:

    • Es una cadena token.

    • Un número expiresInSeconds. Un token vence en esta cantidad de tiempo después de la recuperación. El recuperador de tokens de autenticación debe pasar el tiempo de vencimiento en segundos, desde el momento de la recuperación hasta la biblioteca, como se muestra en el ejemplo.

  • El recuperador debe llamar a una URL en tu servidor para recuperar un token. Esta URL (SERVER_TOKEN_URL) depende de la implementación de tu backend. La siguiente URL de ejemplo es para el backend de la app de ejemplo en GitHub:

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

Ejemplo: Crea un recuperador de tokens de autenticación

En los siguientes ejemplos, se muestra cómo crear un recuperador de tokens de autorización:

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

¿Qué sigue?