Descripción general

La API de pases de la Billetera de Google permite a los socios guardar códigos de barras rotativos en la Billetera de Google. Estos códigos de barras solo son válidos por un período breve, lo que proporciona seguridad adicional para reducir el riesgo de tomar capturas de pantalla de códigos de barras. Los códigos de barras se generan en el dispositivo de acuerdo con la RFC 6238, y el socio proporciona la clave secreta. Sin embargo, si un socio prefiere generar los códigos de barras por su cuenta, Google proporciona una API para que los códigos de barras se puedan subir por lotes a Google. Estos códigos de barras se pasarán a los teléfonos de los usuarios, donde actuarán como códigos de barras rotativos y se mostrarán durante un período breve. Nos referimos a esta solución como códigos de barras rotativos generados por el socio.

API de código de barras rotativo generada por el socio

Los códigos de barras rotativos generados por socios se crean con el mismo objeto RotatingBarcode. Solo el tipo es obligatorio, aunque también recomendamos crear un pequeño conjunto inicial de códigos de barras (aprox. 10 minutos) y enviarlos en initialRotatingBarcodeValues. El socio es responsable de garantizar que siempre haya un código de barras válido listo para el usuario, y initialRotatingBarcodeValues permite que la llamada de carga por lotes posterior sea asíncrona.

  rotatingBarcode {
    initialRotatingBarcodeValues: object (RotatingBarcodeValues),
    type: enum (BarcodeType),
  }
Campo Descripción
initialRotatingBarcodeValues

object (RotatingBarcodeValues)

Valores que se codificarán en el código de barras. Debes ingresar al menos un valor. El propósito de estos códigos de barras iniciales es cerrar la brecha entre el momento en que el usuario obtiene su pase por primera vez y el momento en que se realiza la llamada de carga por lotes posterior.

type

enum (BarcodeType)

Obligatorio. Es el tipo de este código de barras.

Los valores aceptables son:

  • QR_CODE
  • PDF_417

RotatingBarcodeValues
Campo Descripción
startDateTime

string

Fecha y hora en la que es válido el primer código de barras. Se rotarán los códigos de barras con periodMillis.

Se trata de una fecha y hora con formato extendido ISO 8601, con una compensación.

values[]

string

Valores que se codificarán en el código de barras. Debes ingresar al menos un valor.

No hay una cantidad máxima de valores, pero ten en cuenta que el tamaño del cuerpo de la solicitud no puede superar los 5 MB.

periodMillis

number

La cantidad de tiempo durante el cual es válido cada código de barras.

Actualización de valores de códigos de barras por lotes

Después de crear el objeto RotatingBarcode, recomendamos subir los códigos de barras de un día, todos los días, hasta que venza el pase del usuario. Esto se puede hacer con el siguiente extremo de la API de REST.

Método: transitobject.uploadrotatingbarcodevalues

Sube valores de código de barras rotativos al objeto de transporte público al que hace referencia el ID de objeto determinado.

Solicitud HTTP

POST https://walletobjects.googleapis.com/upload/walletobjects/v1/transitObject/{resourc eId}/uploadRotatingBarcodeValues

Parámetros de ruta de acceso

Parámetro Descripción
resourceId

string

El identificador único de un objeto.

Cuerpo de la solicitud

El cuerpo de la solicitud (que no puede superar los 5 MB) contiene una instancia de RotatingBarcodeValues.

Método: transitobject.downloadrotatingbarcodevalues

Descarga valores de códigos de barras rotativos para el objeto de transporte público al que hace referencia el ID de objeto determinado. Esto es útil si los socios quieren verificar el lote más reciente.

Solicitud HTTP

GET https://walletobjects.googleapis.com/walletobjects/v1/transitObject/{resourceId}/do wnloadRotatingBarcodeValues?alt=media

Parámetros de ruta de acceso

Parámetro Descripción
resourceId

string

El identificador único de un objeto.

Mecanismos de resguardo

Ten en cuenta que si un RotatingBarcode válido no tiene códigos de barras válidos para mostrar (aún no se subieron o se usaron todos los códigos de barras actuales), se mostrará un mensaje de error al usuario.