Crie integrações em grande escala para Apple Wallet (.pkpass) e Google Wallet. Emita, atualize, valide e transmita notificações em tempo real através de APIs REST prontas para produção.
O gerenciamento de passes segue um ciclo de vida de 6 etapas: 1. Modelo (projeto visual) → 2. Passe (registro assinado criptograficamente) → 3. Distribuição (passAccessUrl segura) → 4. Registro na Wallet (o dispositivo se registra com APNs / Google Push) → 5. Atualizações ao vivo (notificações em tempo real) → 6. Telemetria de leitura e resgate (validação e webhooks).
1. ModeloPOST /api/v1/templates
Layout mestre, tipo de código de barras, cores da marca e campos de esquema
Conceitos principais
Mecânicas de passes e motor de fidelidade
Associe mecânicas de negócio com estado a modelos em 8 soluções prontas (Fidelidade, Cartões de selos, Cupons, Cartões-presente/pré-pagos, Ingressos, Associações, Crachás de funcionários, Cartões VIP). As regras executam atomicamente na leitura ou chamada API.
LOYALTY_PROGRAM
LOYALTY_PROGRAM e Níveis
Acúmulo de pontos por leitura (defaultChangeValue) com progressão automática de nível
STAMP_CARD
STAMP_CARD_ADD / DEDUCT
Controla posições de selos (0..maximumValue) com onCap ('noop' | 'reset') e rewardClaimBehavior
PREPAID_CARD
Razão PREPAID_CARD
Contabilidade de razão pré-paga em subunidades ISO 4217 com aplicação de disallowNegativeBalance
VALID_ONCE_PER_DAY
VALID_ONCE_PER_DAY e RENEW
Limites diários por fuso horário e extensão automática de expirationDate na leitura
Gestão de passes
11 endpoints
POSThttps://api.passinstance.com/api/v1/passesChave de API
Gestão de passes
Emitir um novo passe
Crie e emita um novo passe Apple Wallet (.pkpass) e Google Wallet a partir de um modelo com campos do cliente, código de barras e valores dinâmicos.
Cabeçalhos2 obrigatório(s) • 1 opcional(is)
X-API-Keystring
Obrigatório
Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.
Exemplo: pi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Typestring
Obrigatório
Deve ser application/json.
Exemplo: application/json
Parâmetros de consulta2 opcional(is)
Payload Payload da requisição contendo ID do modelo, número de série único, valores de campos do cliente e configuração opcional de código de barras.
Corpo da requisição1 obrigatório(s) • 15 opcional(is)
PATCHhttps://api.passinstance.com/api/v1/passes/{id}Chave de API
Gestão de passes
Atualizar passe e enviar push
Atualize campos dinâmicos, cores ou código de barras do passe e transmita automaticamente notificações push APNs e Google Wallet para dispositivos instalados.
Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório
Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.
POSThttps://api.passinstance.com/api/v1/passes/{id}/useChave de API
Gestão de passes
Aplicar ação de mecânica
Execute uma operação atômica de mecânica do passe: INCREMENT (cartão de selos), DECREMENT, DEBIT (saldo pré-pago), CREDIT ou VALIDATE (cupom de uso único).
Cabeçalhos3 obrigatório(s)
X-API-Keystring
Obrigatório
Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.
Exemplo: pi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Typestring
Obrigatório
Deve ser application/json.
Exemplo: application/json
Idempotency-Keystring
Obrigatório
UUID obrigatório para garantir execução atômica e evitar deduções duplicadas de saldo ou selos.
Resolva uma página pública personalizada de download de passe por slug (sem prefixo GET /d/{slug}/info). Para consulta autenticada de gestão, use GET /api/v1/download-pages/slug/{slug}.
Parâmetros de caminho1 obrigatório(s)
slugstring
Obrigatório
Slug vanity exclusivo da página de download hospedada.
POSThttps://api.passinstance.com/api/v1/passes/{id}/notificationsChave de API
Notificações push
Enviar notificação na tela de bloqueio
Envie uma notificação push imediata para um passe Apple Wallet (.pkpass) ou Google Wallet instalado. Para envios agendados ou personalização de cabeçalho, use POST /api/v1/push-notifications/passes/{id}.
Cabeçalhos1 obrigatório(s)
X-API-Keystring
Obrigatório
Chave de API secreta do workspace (pi_live_... ou pi_test_...). Alternativamente, envie Authorization: ApiKey <key>.
Exemplo: pi_live_98a7b6c5d4e3f2a1
Parâmetros de caminho1 obrigatório(s)
idUUID
Obrigatório
UUID exclusivo da instância do passe que receberá a notificação.
Exemplo: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
Payload da requisição contendo o corpo da mensagem e título de cabeçalho opcional.
Corpo da requisição1 obrigatório(s) • 1 opcional(is)
messagestring
Obrigatório
Mensagem de texto a ser exibida na tela de bloqueio do usuário.
Exemplo: Your reward points have been updated! You now have 250 points.