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

Bündelverwaltung

4 Endpunkte
POSThttps://api.passinstance.com/api/v1/bundles/upsertAPI-Schlüssel
Bündelverwaltung

Pass-Bündel erstellen oder aktualisieren

Ein Multi-Pass-Bündel (.pkpasses) erstellen oder aktualisieren, mit dem Nutzer mehrere zusammengehörige Pässe in einem Schritt installieren 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

Array of pass UUIDs (up to 10) and optional existing bundleId.

Anfrage-Body1 erforderlich • 1 fakultativ
passesstring[] (UUID)
Erforderlich

Array mit 1 bis 10 Pass-UUIDs, die zu einem Bündel zusammengefasst werden.

Beispiel: ["b1d972dc-eccf-4f87-ab21-25939d9213d8", "c2e083ed-fddf-4a98-bc32-36040e0324e9"]

Antwort-Statuscodes

GEThttps://api.passinstance.com/api/v1/bundles/{id}/passesAPI-Schlüssel
Bündelverwaltung

Pässe im Bündel auflisten

Alle einzelnen Pässe auflisten, die aktuell einem Pass-Bündel zugeordnet sind, einschließlich Status und Seriennummern.

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

UUID des Pass-Bündels.

Beispiel: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b
Query-Parameter3 fakultativ

Antwort-Statuscodes

POSThttps://api.passinstance.com/api/v1/bundles/{id}/voidAPI-Schlüssel
Bündelverwaltung

Bündel-Pässe entwerten

Alle in einem Pass-Bündel enthaltenen Pässe in einer einzigen Operation entwerten oder reaktivieren.

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

UUID des Pass-Bündels.

Beispiel: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Confirmation flag and optional audit reason for voiding all passes in the bundle.

Anfrage-Body1 erforderlich • 1 fakultativ
voidedboolean
Erforderlich

Muss auf true gesetzt sein, um alle Pässe im Bündel zu entwerten.

Beispiel: true

Antwort-Statuscodes

DELETEhttps://api.passinstance.com/api/v1/bundles/{id}API-Schlüssel
Bündelverwaltung

Pass-Bündel löschen

Eine Pass-Bündel-Gruppierung löschen (optional unter Beibehaltung oder Widerruf der darunterliegenden Einzelpässe).

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

UUID des zu löschenden Pass-Bündels.

Beispiel: e5f6a7b8-c9d0-4e1f-8a2b-3c4d5e6f7a8b

Antwort-Statuscodes