Skip to content
Referencia de API REST y SDKs

Documentación para desarrolladores de Passinstance

Cree integraciones de alto volumen con Apple Wallet (.pkpass) y Google Wallet. Emita, actualice, escanee y envíe notificaciones en tiempo real mediante APIs REST de nivel de producción.

Obtener claves API
Entorno interactivo — los fragmentos se actualizan mientras escribes
Equivalente visual del Dashboard
Elementos clave de la interfaz

Vista en Dashboard: Claves personalizadas y reglas

Las claves declaradas en Custom properties (p. ej., holderName, validUntil) coinciden exactamente con los campos JSON de la API.

Gestión de plantillas

7 endpoints
GEThttps://api.passinstance.com/api/v1/templatesClave API
Gestión de plantillas

Listar todas las plantillas

Recupere una lista paginada de plantillas de pases pertenecientes al contexto de cliente autenticado.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de consulta3 opcional(es)

Códigos de estado de respuesta

GEThttps://api.passinstance.com/api/v1/templates/{id}Clave API
Gestión de plantillas

Obtener detalles de la plantilla

Recupere los detalles completos de una plantilla de pase, incluidos colores, configuración de código de barras, campos y reglas mecánicas.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idUUID
Obligatorio

Identificador único de la plantilla.

Ejemplo: tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Códigos de estado de respuesta

GEThttps://api.passinstance.com/api/v1/templates/{id}/fieldsClave API
Gestión de plantillas

Obtener campos de plantilla

Recupere las definiciones de campos dinámicos y claves personalizadas que pueden completarse por pase para una plantilla determinada.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

UUID único de la plantilla.

Ejemplo: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
Parámetros de consulta1 opcional(es)

Códigos de estado de respuesta

POSThttps://api.passinstance.com/api/v1/templatesClave API
Gestión de plantillas

Crear una plantilla de pase

Diseñe y registre una nueva plantilla reutilizable con imagen de marca, tipo de código de barras, configuración NFC y campos de diseño.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1

Configuración de creación de plantilla acorde al esquema JSON OpenAPI.

Cuerpo de la solicitud6 obligatorio(s) • 4 opcional(es)
namestring
Obligatorio

Nombre visible de la plantilla.

Ejemplo: VIP Loyalty Card Template
descriptionstring
Obligatorio

Descripción detallada del propósito del pase y beneficios de nivel.

Ejemplo: Exclusive loyalty and rewards card for VIP customers
organizationNamestring
Obligatorio

Nombre de organización o marca impreso en el encabezado.

Ejemplo: Acme Rewards
kindstring (enum)
Obligatorio

storeCard, coupon, eventTicket, generic, boardingPass o membership.

Ejemplo: storeCard
statusstring (enum)
Obligatorio

DRAFT, PUBLISHED, ARCHIVED, DEPRECATED o UNDER_REVIEW.

Ejemplo: PUBLISHED
preferredStyleSchemestring (enum)
Obligatorio

DARK, posterGeneric, posterEventTicket, bannerEventTicket o semanticBoardingPass.

Ejemplo: DARK

Códigos de estado de respuesta

POSThttps://api.passinstance.com/api/v1/templates/{id}/publishClave API
Gestión de plantillas

Publicar borrador de plantilla

Promueva una revisión en borrador (rowKind: DRAFT) a PUBLISHED, marque changesToPush: true y encole actualizaciones en segundo plano APNs y Google Wallet para todos los pases activos.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

UUID de la plantilla a publicar.

Ejemplo: tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Carga útil de solicitud que controla la publicación inmediata o programada y la propagación push a wallets.

Cuerpo de la solicitud4 opcional(es)

Códigos de estado de respuesta

POSThttps://api.passinstance.com/api/v1/templates/{id}/copyClave API
Gestión de plantillas

Duplicar plantilla

Clone una plantilla de pase existente con su diseño, colores, imágenes y mecánicas dentro del mismo espacio de trabajo.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

UUID de la plantilla de origen que se desea duplicar.

Ejemplo: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Optional name, description, and ISO 4217 currency override for the duplicated template.

Cuerpo de la solicitud3 opcional(es)

Códigos de estado de respuesta

DELETEhttps://api.passinstance.com/api/v1/templates/{id}Clave API
Gestión de plantillas

Eliminar plantilla

Elimine una plantilla de pase y programe una tarea asíncrona para revocar y desactivar los pases asociados en Apple Wallet y Google Wallet.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

UUID de la plantilla que se va a eliminar.

Ejemplo: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Códigos de estado de respuesta

Notificaciones de plantilla

3 endpoints
POSThttps://api.passinstance.com/api/v1/push-notifications/templates/{id}/sendClave API
Notificaciones de plantilla

Difundir push a los pases de una plantilla

Difunda una notificación push inmediata en pantalla de bloqueo a todos los pases activos de Apple Wallet y Google Wallet de una plantilla.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

UUID de la plantilla cuyos dispositivos registrados recibirán la difusión.

Ejemplo: tpl_8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Carga útil Carga útil de solicitud con pushNotificationText (máx. 85 caracteres) y texto de encabezado opcional.

Cuerpo de la solicitud1 obligatorio(s) • 1 opcional(es)
pushNotificationTextstring
Obligatorio

Mensaje en pantalla de bloqueo enviado a pases activos (máx. 85 caracteres; admite variables).

Ejemplo: Flash Sale starts now! Show your VIP pass at checkout for 2x points.

Códigos de estado de respuesta

GEThttps://api.passinstance.com/api/v1/templates/{id}/notificationClave API
Notificaciones de plantilla

Listar notificaciones programadas

Liste todas las campañas de notificaciones push programadas y ejecutadas recientemente para una plantilla de pase específica.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
idstring (UUID)
Obligatorio

Template UUID.

Ejemplo: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b

Códigos de estado de respuesta

DELETEhttps://api.passinstance.com/api/v1/templates/notification/{notificationId}Clave API
Notificaciones de plantilla

Cancelar notificación programada

Cancele una notificación push de plantilla programada pendiente antes de que se envíe a los dispositivos registrados.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1
Parámetros de ruta1 obligatorio(s)
notificationIdstring (UUID)
Obligatorio

UUID de la notificación programada devuelto al listar o programar notificaciones.

Ejemplo: f1e2d3c4-b5a6-4987-8765-43210fedcba9

Códigos de estado de respuesta

Integraciones de plantilla

2 endpoints
POSThttps://api.passinstance.com/api/v1/integration-connections/embed-widgetsClave API
Integraciones de plantilla

Crear integración embebida (iFrame)

Cree una configuración de widget iFrame integrable para una plantilla publicada y permita el registro de pases directamente en su sitio web.

Encabezados1 obligatorio(s)
X-API-Keystring
Obligatorio

Clave API secreta del espacio de trabajo (pi_live_... o pi_test_...). Alternativamente puede enviar Authorization: ApiKey <key>.

Ejemplo: pi_live_98a7b6c5d4e3f2a1

Configuration for the embedded download widget including templateId and allowed host domains.

Cuerpo de la solicitud3 obligatorio(s) • 1 opcional(es)
namestring
Obligatorio

Nombre visible para la integración del widget embebido.

Ejemplo: Checkout Loyalty Embed Widget
templateIdstring (UUID)
Obligatorio

UUID de la plantilla de pase de destino.

Ejemplo: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
allowedDomainsstring[]
Obligatorio

Lista de orígenes (dominios) autorizados para incrustar el widget.

Ejemplo: ["shop.yourbrand.com", "app.yourbrand.com"]

Códigos de estado de respuesta