Erstellen Sie hochvolumige Apple Wallet (.pkpass) und Google Wallet Integrationen. Ausstellen, aktualisieren, scannen und Echtzeit-Benachrichtigungen über produktive REST-APIs übertragen.
Die Passverwaltung folgt einem 6-stufigen Lebenszyklus: 1. Vorlage (visueller Bauplan) → 2. Pass (kryptografisch signierter Datensatz) → 3. Verteilung (sichere passAccessUrl) → 4. Wallet-Registrierung (Gerät registriert sich bei APNs / Google Push) → 5. Live-Updates (Echtzeit-Sperrbildschirm-Benachrichtigungen) → 6. Scan- & Einlösetelemetrie (Barcode-Validierung & Webhook-Stream).
1. VorlagePOST /api/v1/templates
Master-Layout, Barcode-Typ, Markenfarben und Schemafelder
Kernkonzepte
Pass-Mechaniken & Loyalty-Solutions-Engine
Verknüpfen Sie zustandsbehaftete Geschäftsmechaniken über 8 schlüsselfertige Lösungen hinweg mit Vorlagen (Treueprogramme, Stempelkarten, Coupons, Geschenkkarten/Prepaid, Event-Tickets, Mitgliedschaften, Mitarbeiterausweise, VIP-Karten). Regeln werden beim Scan oder API-Aufruf atomar ausgeführt.
LOYALTY_PROGRAM
LOYALTY_PROGRAM & Stufen
Punktegutschrift pro Scan (defaultChangeValue) mit automatischer Stufenprogression
STAMP_CARD
STAMP_CARD_ADD / DEDUCT
Verfolgt Stempelpositionen (0..maximumValue) mit onCap ('noop' | 'reset') und rewardClaimBehavior
PREPAID_CARD
PREPAID_CARD Ledger
ISO-4217-Prepaid-Ledger-Buchhaltung in kleinsten Währungseinheiten mit disallowNegativeBalance-Durchsetzung
VALID_ONCE_PER_DAY
VALID_ONCE_PER_DAY & RENEW
Zeitzonenbewusste tägliche Check-in-Limits und automatische Verlängerung von expirationDate beim Scan
Erstellen und signieren Sie einen neuen Apple Wallet (.pkpass) & Google Wallet Pass aus einer Vorlage mit Kundenfeldern, Barcode und dynamischen Werten.
Header2 erforderlich • 1 fakultativ
X-API-Keystring
Erforderlich
Geheimer Workspace-API-Schlüssel (pi_live_... oder pi_test_...). Alternativ kann Authorization: ApiKey <key> gesendet werden.
Beispiel: pi_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Typestring
Erforderlich
Muss application/json sein.
Beispiel: application/json
Query-Parameter2 fakultativ
Nutzlast mit Vorlagen-ID, eindeutiger Seriennummer, Kundenfeldwerten und optionaler Barcode-Konfiguration.
Dynamische Felder, Farben oder Barcodes eines Passes aktualisieren und automatisch APNs- und Google Wallet-Push-Benachrichtigungen an installierte Geräte senden.
Header1 erforderlich
X-API-Keystring
Erforderlich
Geheimer Workspace-API-Schlüssel (pi_live_... oder pi_test_...). Alternativ kann Authorization: ApiKey <key> gesendet werden.
Beispiel: pi_live_98a7b6c5d4e3f2a1
Pfad-Parameter1 erforderlich
idstring (UUID)
Erforderlich
Die eindeutige UUID des zu aktualisierenden Passes.
Öffentliche gebrandete Pass-Download-Seite anhand des Slugs auflösen (präfixfrei GET /d/{slug}/info). Für authentifizierte Verwaltungssuche nutzen Sie GET /api/v1/download-pages/slug/{slug}.
Pfad-Parameter1 erforderlich
slugstring
Erforderlich
Eindeutiger Vanity-Slug der gehosteten Download-Seite.
Sofortige Push-Benachrichtigung und Sperrbildschirm-Nachricht an einen installierten Apple Wallet (.pkpass) oder Google Wallet Pass senden. Für geplante Sendungen oder Header-Anpassung nutzen Sie POST /api/v1/push-notifications/passes/{id}.
Header1 erforderlich
X-API-Keystring
Erforderlich
Geheimer Workspace-API-Schlüssel (pi_live_... oder pi_test_...). Alternativ kann Authorization: ApiKey <key> gesendet werden.
Beispiel: pi_live_98a7b6c5d4e3f2a1
Pfad-Parameter1 erforderlich
idUUID
Erforderlich
Eindeutige Pass-Instanz-UUID, die die Benachrichtigung erhalten soll.
Beispiel: 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
Anfrage mit Nachrichtentext und optionalem Header-Titel.
Anfrage-Body1 erforderlich • 1 fakultativ
messagestring
Erforderlich
Textnachricht, die auf dem Sperrbildschirm des Nutzers angezeigt wird.
Beispiel: Your reward points have been updated! You now have 250 points.