概览

借助 Google Wallet Passs API,合作伙伴可以为用户指定端点, 公交票卡激活。当需要激活时,系统会显示“激活”按钮 。 端点应确保卡券包含有效的兑换信息(条形码或 目视检查),此时系统会更新用户 Google 钱包中的卡券 以显示兑换信息。请注意,在激活之前, 信息。

激活 API

在 API 中使用 activationOptions 来指定激活端点, 公交类别。 合作伙伴负责维护一个正常运行的激活端点, 合理延迟时间

  activationOptions: {
    activationUrl: string
  }
字段 说明
activationUrl

string

为激活请求调用的合作伙伴端点的网址。网址应 托管在 HTTPS 上,而 robots.txt 应允许 UserAgent:Google-Valuables。

激活状态使用 activationStatus 字段存储在对象上。 有效状态包括 NOT_ACTIVATEDACTIVATED。激活 端点应以 ACTIVATED 状态更新对象,并确保 对象具有有效的兑换信息,例如条形码或视觉检测参数。通过 deviceContext 字段可用于设备固定

  activationStatus: enum (ActivationStatus),
  deviceContext: {
    deviceToken: string
  },
  hasLinkedDevice: boolean
字段 说明
activationStatus

enum (ActivationStatus)

此公交对象的激活状态。此状态会改变 工单并允许用户采取行动;例如屏幕上会显示“激活”按钮 票券详细信息(如果设为 NOT_ACTIVATED)。

可接受的值包括:

  • NOT_ACTIVATED
  • ACTIVATED

deviceContext

object (DeviceContext)

要与对象关联的设备上下文。如果设置,兑换信息将 仅返回给定设备。

hasLinkedDevice

boolean

此对象当前是否已关联到单个设备。

DeviceContext
字段 说明
deviceToken

string

如果设置,则只有在激活后,系统才会将兑换信息退还给指定设备 对象。它不能用作跟踪用户设备的稳定标识符。它 同一设备的不同卡券,甚至是不同卡券 。设置此值时,调用方还必须设置 针对要激活的对象的 hasLinkedDevice 权限。

请注意,deviceToken 的接收方为 激活参数 deviceContext 字段

设备固定

设备固定是一项功能,可让用户在一台设备上激活票据, 票券兑换信息只会显示在相应设备上。这与 第 multipleDevicesAndHoldersAllowedStatus 个,共 ONE_USER_ONE_DEVICE 个, 仅允许在一台设备上显示门票。建议使用 ONE_USER_ALL_DEVICES(设备固定)。

在激活之前,用户可以在任何设备上查看票券和激活按钮 。激活并固定到设备后,固定的设备就会显示兑换信息 其他设备则会显示一个激活按钮,以便用户将票券转移到其他设备上 设备。如果客户不需要转移车票功能,但在任意设备上激活该功能,则 可以在激活期间将工单更新为 ONE_USER_ONE_DEVICE, 与使用设备固定相比

如需实现设备固定,应使用 deviceToken 字段更新该对象 该值与激活参数以及 在同一 API 调用中将 hasLinkedDevice 设置为 true。如果需要,工单可以 在将来的 API 调用中将 hasLinkedDevice 设置为 false 来解除与设备的关联。

设备固定的序列图

激活参数

向激活端点发出的请求将包含以下参数。

JSON 示例:

  {
    classId: “123.classId”,
    objectIds: [ “123.objectId” ],
    expTimeMillis: 1669671940735,
    eventType: “activate”,
    nonce: “1c6fccce-6f66-11ed-a1eb-0242ac120002”,
    deviceContext: “6fba937a-6f6e-11ed-a1eb-0242ac120002”
  }

标识符 说明
classId

完全限定的类 ID。请使用以下格式:

<issuer_id.class_id>
objectIds

完全限定的对象 ID 数组,其格式如下:

<issuer_id.object_id>
expTimeMillis 到期时间(以毫秒为单位,从 EPOCH 开始)。在该到期时间过后 必须视为无效。
eventType 始终为 "activate"
nonce 用于跟踪任何重复递送的 Nonce。
deviceContext

由 Google 生成的唯一 ID,表示用户对其执行操作的设备。 在进行将对象绑定到设备的更新时,应使用此 ID。

对于将来从给定设备发出的请求,此 ID 可能不是常量。