设置 JavaScript Consumer SDK

借助 JavaScript 消费者 SDK,您的消费者应用可以在基于 Web 的地图上显示车辆位置以及 Fleet Engine 中跟踪的其他感兴趣的地点。这样,您的消费者用户就可以查看其订单的配送进度。本指南假定您已设置好车队引擎及其关联的 Google Cloud 项目和 API 密钥。如需了解详情,请参阅 Fleet Engine

您可以按照以下步骤设置 JavaScript 使用方 SDK:

  1. 启用 Maps JavaScript API
  2. 设置授权

启用 Maps JavaScript API

在您用于 Fleet Engine 实例的 Google Cloud 控制台项目中启用 Maps JavaScript API。如需了解详情,请参阅 Maps JavaScript API 文档中的启用 API

设置授权

对于从低信任环境进行的 API 方法调用,车队引擎要求使用由适当服务账号签名的 JSON Web 令牌 (JWT)。低信任环境包括智能手机和浏览器。JWT 源自您的服务器,即完全受信任的环境。JWT 会经过签名和加密,并传递给客户端以供后续与服务器的互动,直到其过期或失效为止。

您的后端应使用标准应用默认凭据机制对 Fleet Engine 进行身份验证和授权。请务必使用由适当服务账号签名的 JWT。如需查看服务账号角色列表,请参阅车队引擎基础知识中的车队引擎服务账号角色。

您的消费者应用应使用 Google Cloud 项目中的 delivery_consumer 角色对最终用户进行身份验证,以便仅返回特定于消费者的信息。这样一来,车队引擎就会过滤和隐去响应中的所有其他信息。例如,在不可用性任务期间,系统不会与最终用户分享任何位置信息。如需了解安排的任务,请参阅服务账号角色

与之相反,您的后端应使用标准应用默认凭据机制对 Fleet Engine 进行身份验证和授权。

授权的工作原理

使用车队引擎数据的授权涉及服务器端和客户端实现。

服务器端授权

在基于 Web 的应用中设置身份验证和授权之前,您的后端服务器必须能够向您的基于 Web 的应用发出 JSON Web 令牌,以便应用访问车队引擎。您的基于 Web 的应用会随请求一起发送这些 JWT,以便 Fleet Engine 将请求识别为已通过身份验证且有权访问请求中的数据。如需了解服务器端 JWT 实现的说明,请参阅车队引擎必备知识下的签发 JSON Web 令牌

具体而言,对于用于跟踪配送的 JavaScript 消费者 SDK,请注意以下事项:

客户端授权

当您使用 JavaScript 使用方 SDK 时,该 SDK 会使用授权令牌提取器从服务器请求令牌。当满足以下任一条件时,系统就会执行此操作:

  • 不存在有效的令牌,例如当 SDK 未在新页面加载时调用提取器,或者提取器未返回令牌时。

  • 令牌已过期。

  • 令牌将在一分钟内过期。

否则,JavaScript 使用方 SDK 会使用之前签发的有效令牌,而不会调用提取器。

创建授权令牌提取器

请按照以下准则创建授权令牌提取器:

  • 提取器必须返回包含两个字段的数据结构,并将其封装在 Promise 中,如下所示:

    • 字符串 token

    • 一个数字 expiresInSeconds。令牌会在提取后此时长过期。身份验证令牌提取器必须将从提取到库的时间(以秒为单位)传递给库,如示例所示。

  • 提取器应调用服务器上的网址以检索令牌。此网址(SERVER_TOKEN_URL)取决于您的后端实现。以下示例网址适用于 GitHub 上的示例应用后端

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

示例 - 创建身份验证令牌提取器

以下示例展示了如何创建授权令牌提取器:

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

后续步骤