Skip to content
REST-API-Referenz & SDKs

Passinstance Entwickler-Dokumentation

Erstellen Sie hochvolumige Apple Wallet (.pkpass) und Google Wallet Integrationen. Ausstellen, aktualisieren, scannen und Echtzeit-Benachrichtigungen über produktive REST-APIs übertragen.

API-Schlüssel erhalten
Live-Docs-Workbench — Codebeispiele aktualisieren sich während der Eingabe
Dashboard-UI-Gegenstück
Wichtige UI-Elemente

Dashboard-Gegenstück: Custom-Property-Keys & Validierung

Die in Custom properties definierten Schlüssel (z. B. holderName, validUntil) entsprechen exakt den JSON-Payload-Feldern der API.

Vorlagenverwaltung

7 Endpunkte
GEThttps://api.passinstance.com/api/v1/templatesAPI-Schlüssel
Vorlagenverwaltung

Alle Vorlagen auflisten

Paginierte Liste der Pass-Vorlagen abrufen, die zum authentifizierten Kunden-Workspace gehören.

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
Query-Parameter3 fakultativ

Antwort-Statuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}API-Schlüssel
Vorlagenverwaltung

Vorlagendetails abrufen

Vollständige Details einer Pass-Vorlage einschließlich Farben, Barcode-Einstellungen, Layoutfeldern und Mechanik-Regeln abrufen.

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 Vorlagenkennung.

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

Antwort-Statuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}/fieldsAPI-Schlüssel
Vorlagenverwaltung

Vorlagenfelder abrufen

Berechnete dynamische Felddefinitionen und benutzerdefinierte Eigenschaftsschlüssel abrufen, die pro Pass für eine Vorlage befüllt werden können.

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

Eindeutige Vorlagen-UUID.

Beispiel: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
Query-Parameter1 fakultativ

Antwort-Statuscodes

POSThttps://api.passinstance.com/api/v1/templatesAPI-Schlüssel
Vorlagenverwaltung

Pass-Vorlage erstellen

Neue wiederverwendbare Pass-Vorlage mit visuellem Branding, Barcode-Typ, NFC-Konfiguration und Layoutfeldern entwerfen und registrieren.

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

Vorlagen-Anfragekonfiguration gemäß OpenAPI-JSON-Schema.

Anfrage-Body6 erforderlich • 4 fakultativ
namestring
Erforderlich

Anzeigename der Vorlage.

Beispiel: VIP Loyalty Card Template
descriptionstring
Erforderlich

Ausführliche Beschreibung von Zweck und Stufenvorteilen des Passes.

Beispiel: Exclusive loyalty and rewards card for VIP customers
organizationNamestring
Erforderlich

Organisations-/Markenname im Karten-Header.

Beispiel: Acme Rewards
kindstring (enum)
Erforderlich

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

Beispiel: storeCard
statusstring (enum)
Erforderlich

DRAFT, PUBLISHED, ARCHIVED, DEPRECATED oder UNDER_REVIEW.

Beispiel: PUBLISHED
preferredStyleSchemestring (enum)
Erforderlich

DARK, posterGeneric, posterEventTicket, bannerEventTicket oder semanticBoardingPass.

Beispiel: DARK

Antwort-Statuscodes

POSThttps://api.passinstance.com/api/v1/templates/{id}/publishAPI-Schlüssel
Vorlagenverwaltung

Vorlagen-Entwurf veröffentlichen

Vorlagen-Entwurfsrevision (rowKind: DRAFT) auf PUBLISHED hochstufen, changesToPush: true setzen und APNs- sowie Google Wallet-Updates für alle aktiven Pässe einreihen.

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

Zu veröffentlichende Vorlagen-UUID.

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

Anfrage zur Steuerung sofortiger vs. geplanter Veröffentlichung und Wallet-Push-Verteilung.

Anfrage-Body4 fakultativ

Antwort-Statuscodes

POSThttps://api.passinstance.com/api/v1/templates/{id}/copyAPI-Schlüssel
Vorlagenverwaltung

Vorlage duplizieren

Eine bestehende Pass-Vorlage einschließlich Layout, Farben, Bildern und Mechaniken innerhalb desselben Kunden-Workspaces klonen.

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

Quell-Vorlagen-UUID, die dupliziert werden soll.

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

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

Anfrage-Body3 fakultativ

Antwort-Statuscodes

DELETEhttps://api.passinstance.com/api/v1/templates/{id}API-Schlüssel
Vorlagenverwaltung

Vorlage löschen

Eine Pass-Vorlage löschen und eine asynchrone Hintergrundaufgabe starten, um zugehörige Pässe in Apple Wallet und Google Wallet zu widerrufen.

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

Zu löschende Vorlagen-UUID.

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

Antwort-Statuscodes

Vorlagen-Benachrichtigungen

3 Endpunkte
POSThttps://api.passinstance.com/api/v1/push-notifications/templates/{id}/sendAPI-Schlüssel
Vorlagen-Benachrichtigungen

Push an alle Vorlagen-Pässe senden

Sofortige Sperrbildschirm-Push-Benachrichtigung an alle aktiven Apple Wallet und Google Wallet Pässe einer Vorlage 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

Vorlagen-UUID, deren registrierte Geräte die Rundsendung erhalten.

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

Nutzlast mit pushNotificationText (max. 85 Zeichen) und optionalem Header-Text.

Anfrage-Body1 erforderlich • 1 fakultativ
pushNotificationTextstring
Erforderlich

Sperrbildschirm-Benachrichtigung an aktive Vorlagen-Pässe (max. 85 Zeichen; unterstützt Platzhalter).

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

Antwort-Statuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}/notificationAPI-Schlüssel
Vorlagen-Benachrichtigungen

Geplante Benachrichtigungen auflisten

Alle geplanten und kürzlich ausgeführten Push-Benachrichtigungskampagnen für eine bestimmte Pass-Vorlage auflisten.

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

Template UUID.

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

Antwort-Statuscodes

DELETEhttps://api.passinstance.com/api/v1/templates/notification/{notificationId}API-Schlüssel
Vorlagen-Benachrichtigungen

Geplante Benachrichtigung stornieren

Eine ausstehende geplante Push-Benachrichtigung für eine Vorlage stornieren, bevor sie an die Wallet-Geräte gesendet wird.

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

UUID der geplanten Benachrichtigung aus der Planungs- oder Listenabfrage.

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

Antwort-Statuscodes

Vorlagen-Integrationen

2 Endpunkte
POSThttps://api.passinstance.com/api/v1/integration-connections/embed-widgetsAPI-Schlüssel
Vorlagen-Integrationen

Embed-Integration erstellen (iFrame)

Eine einbettbare iFrame-Widget-Konfiguration für eine veröffentlichte Vorlage erstellen, um PassFlow-Registrierungen auf Ihrer Website einzubetten.

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

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

Anfrage-Body3 erforderlich • 1 fakultativ
namestring
Erforderlich

Anzeigename für die Embed-Widget-Integration.

Beispiel: Checkout Loyalty Embed Widget
templateIdstring (UUID)
Erforderlich

UUID der Ziel-Pass-Vorlage.

Beispiel: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
allowedDomainsstring[]
Erforderlich

Liste zulässiger Ursprungs-Domains (Origins), die das Widget einbetten dürfen.

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

Antwort-Statuscodes