Crea integrazioni su larga scala per Apple Wallet (.pkpass) e Google Wallet. Emetti, aggiorna, scansiona e invia notifiche in tempo reale tramite API REST pronte per la produzione.
La gestione dei pass segue un ciclo di vita in 6 fasi: 1. Modello (progetto visivo) → 2. Pass (record firmato crittograficamente) → 3. Distribuzione (passAccessUrl sicura) → 4. Registrazione Wallet (il dispositivo si registra su APNs / Google Push) → 5. Aggiornamenti in tempo reale (notifiche su schermata di blocco) → 6. Telemetria di scansione e riscatto (validazione e webhook).
1. ModelloPOST /api/v1/templates
Layout master, tipo di codice a barre, colori del brand e campi dello schema
Concetti chiave
Meccaniche dei pass e motore di fidelizzazione
Collega meccaniche aziendali con stato ai modelli su 8 soluzioni pronte all'uso (Fedeltà, Carte timbri, Coupon, Carte regalo/prepagate, Biglietti eventi, Abbonamenti, Badge dipendenti, Carte VIP). Le regole vengono eseguite in modo atomico alla scansione o chiamata API.
LOYALTY_PROGRAM
LOYALTY_PROGRAM e Livelli
Accumulo punti per scansione (defaultChangeValue) con avanzamento automatico di livello
STAMP_CARD
STAMP_CARD_ADD / DEDUCT
Traccia le posizioni timbro (0..maximumValue) con onCap ('noop' | 'reset') e rewardClaimBehavior
PREPAID_CARD
Libro mastro PREPAID_CARD
Contabilità di registro prepagato in unità minime ISO 4217 con applicazione disallowNegativeBalance
VALID_ONCE_PER_DAY
VALID_ONCE_PER_DAY e RENEW
Limiti giornalieri consapevoli del fuso orario ed estensione automatica di expirationDate alla scansione
Gestione pass
11 endpoint
POSThttps://api.passinstance.com/api/v1/passesChiave API
Gestione pass
Emetti un nuovo pass
Crea ed emetti un nuovo pass Apple Wallet (.pkpass) e Google Wallet da un modello con campi cliente, codice a barre e valori dinamici.
Intestazioni2 obbligatori • 1 opzionali
X-API-Keystring
Obbligatorio
Chiave API segreta del workspace (pi_live_... o pi_test_...). In alternativa è possibile inviare Authorization: ApiKey <key>.
Esempio: pi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Typestring
Obbligatorio
Deve essere application/json.
Esempio: application/json
Parametri di query2 opzionali
Payload Payload della richiesta contenente ID modello, numero di serie univoco, campi cliente e configurazione opzionale del codice a barre.
Risolvi una pagina pubblica personalizzata di download pass tramite slug (senza prefisso GET /d/{slug}/info). Per la ricerca gestionale autenticata usa GET /api/v1/download-pages/slug/{slug}.
Parametri di percorso1 obbligatori
slugstring
Obbligatorio
Slug vanity univoco della pagina di download ospitata.
POSThttps://api.passinstance.com/api/v1/passes/{id}/notificationsChiave API
Notifiche push
Invia notifica su schermata di blocco
Invia una notifica push immediata sulla schermata di blocco a un pass Apple Wallet (.pkpass) o Google Wallet installato. Per invii programmati o personalizzazione intestazione, usa POST /api/v1/push-notifications/passes/{id}.
Intestazioni1 obbligatori
X-API-Keystring
Obbligatorio
Chiave API segreta del workspace (pi_live_... o pi_test_...). In alternativa è possibile inviare Authorization: ApiKey <key>.
Esempio: pi_live_98a7b6c5d4e3f2a1
Parametri di percorso1 obbligatori
idUUID
Obbligatorio
UUID univoco dell'istanza pass destinataria della notifica.
Esempio: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
Payload della richiesta con corpo del messaggio e titolo d'intestazione opzionale.
Corpo della richiesta1 obbligatori • 1 opzionali
messagestring
Obbligatorio
Messaggio testuale da mostrare sulla schermata di blocco dell'utente.
Esempio: Your reward points have been updated! You now have 250 points.