Skip to content
Riferimento API REST e SDK

Documentazione per sviluppatori Passinstance

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.

Ottieni chiavi API
Workbench live — gli snippet si aggiornano mentre digiti
Corrispettivo visivo Dashboard
Elementi chiave dell'interfaccia

Controparte Dashboard: Chiavi personalizzate e validazione

Le chiavi dichiarate in Custom properties (es. holderName, validUntil) corrispondono esattamente alle chiavi JSON dell'API.

Gestione modelli

7 endpoint
GEThttps://api.passinstance.com/api/v1/templatesChiave API
Gestione modelli

Elenca tutti i modelli

Recupera un elenco paginato di modelli di pass appartenenti al contesto cliente autenticato.

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 query3 opzionali

Codici di stato della risposta

GEThttps://api.passinstance.com/api/v1/templates/{id}Chiave API
Gestione modelli

Ottieni dettagli del modello

Recupera tutti i dettagli di un modello di pass inclusi colori, impostazioni codice a barre, campi layout e regole meccaniche.

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

Identificatore univoco del modello.

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

Codici di stato della risposta

GEThttps://api.passinstance.com/api/v1/templates/{id}/fieldsChiave API
Gestione modelli

Ottieni campi del modello

Recupera le definizioni dei campi dinamici e le chiavi personalizzate compilabili per ogni pass di un determinato modello.

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
idstring (UUID)
Obbligatorio

UUID univoco del modello.

Esempio: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
Parametri di query1 opzionali

Codici di stato della risposta

POSThttps://api.passinstance.com/api/v1/templatesChiave API
Gestione modelli

Crea un modello di pass

Progetta e registra un nuovo modello riutilizzabile con branding visivo, tipo di codice a barre, configurazione NFC e campi di layout.

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

Configurazione della creazione modello conforme allo schema JSON OpenAPI.

Corpo della richiesta6 obbligatori • 4 opzionali
namestring
Obbligatorio

Nome visualizzato del modello.

Esempio: VIP Loyalty Card Template
descriptionstring
Obbligatorio

Descrizione dettagliata dello scopo del pass e dei vantaggi del livello.

Esempio: Exclusive loyalty and rewards card for VIP customers
organizationNamestring
Obbligatorio

Nome dell'organizzazione o brand stampato nell'intestazione.

Esempio: Acme Rewards
kindstring (enum)
Obbligatorio

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

Esempio: storeCard
statusstring (enum)
Obbligatorio

DRAFT, PUBLISHED, ARCHIVED, DEPRECATED o UNDER_REVIEW.

Esempio: PUBLISHED
preferredStyleSchemestring (enum)
Obbligatorio

DARK, posterGeneric, posterEventTicket, bannerEventTicket o semanticBoardingPass.

Esempio: DARK

Codici di stato della risposta

POSThttps://api.passinstance.com/api/v1/templates/{id}/publishChiave API
Gestione modelli

Pubblica bozza del modello

Promuovi una revisione in bozza (rowKind: DRAFT) a PUBLISHED, imposta changesToPush: true e accoda aggiornamenti APNs e Google Wallet in background per tutti i pass attivi.

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
idstring (UUID)
Obbligatorio

UUID del modello da pubblicare.

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

Payload della richiesta che controlla la pubblicazione immediata o pianificata e la propagazione push ai wallet.

Corpo della richiesta4 opzionali

Codici di stato della risposta

POSThttps://api.passinstance.com/api/v1/templates/{id}/copyChiave API
Gestione modelli

Duplica modello

Clona un modello di pass esistente inclusi layout, colori, immagini e meccaniche all'interno dello stesso workspace.

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
idstring (UUID)
Obbligatorio

UUID del modello di origine da duplicare.

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

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

Corpo della richiesta3 opzionali

Codici di stato della risposta

DELETEhttps://api.passinstance.com/api/v1/templates/{id}Chiave API
Gestione modelli

Elimina modello

Elimina un modello di pass e avvia un job asincrono per revocare e disattivare i pass associati su Apple Wallet e Google Wallet.

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
idstring (UUID)
Obbligatorio

UUID del modello da eliminare.

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

Codici di stato della risposta

Notifiche modello

3 endpoint
POSThttps://api.passinstance.com/api/v1/push-notifications/templates/{id}/sendChiave API
Notifiche modello

Trasmetti push a tutti i pass di un modello

Invia una notifica push immediata sulla schermata di blocco a tutti i pass attivi Apple Wallet e Google Wallet emessi da un modello.

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
idstring (UUID)
Obbligatorio

UUID del modello i cui dispositivi registrati riceveranno la trasmissione.

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

Payload Payload della richiesta con pushNotificationText (max 85 caratteri) e testo intestazione opzionale.

Corpo della richiesta1 obbligatori • 1 opzionali
pushNotificationTextstring
Obbligatorio

Messaggio sulla schermata di blocco inviato ai pass attivi (max 85 caratteri; supporta segnaposto).

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

Codici di stato della risposta

GEThttps://api.passinstance.com/api/v1/templates/{id}/notificationChiave API
Notifiche modello

Elenca notifiche pianificate

Elenca tutte le campagne di notifiche push pianificate ed eseguite di recente per uno specifico modello di pass.

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
idstring (UUID)
Obbligatorio

Template UUID.

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

Codici di stato della risposta

DELETEhttps://api.passinstance.com/api/v1/templates/notification/{notificationId}Chiave API
Notifiche modello

Annulla notifica pianificata

Annulla una notifica push pianificata in sospeso prima che venga inviata ai dispositivi wallet registrati.

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
notificationIdstring (UUID)
Obbligatorio

UUID della notifica pianificata restituito durante la pianificazione o l'elenco.

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

Codici di stato della risposta

Integrazioni modello

2 endpoint
POSThttps://api.passinstance.com/api/v1/integration-connections/embed-widgetsChiave API
Integrazioni modello

Crea integrazione incorporata (iFrame)

Crea una configurazione widget iFrame incorporabile per un modello pubblicato per integrare la registrazione dei pass sul tuo sito web.

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

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

Corpo della richiesta3 obbligatori • 1 opzionali
namestring
Obbligatorio

Nome visualizzato per l'integrazione del widget incorporato.

Esempio: Checkout Loyalty Embed Widget
templateIdstring (UUID)
Obbligatorio

UUID del modello di pass di destinazione.

Esempio: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
allowedDomainsstring[]
Obbligatorio

Elenco delle origini (domini) autorizzate a incorporare il widget.

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

Codici di stato della risposta