Skip to content
REST API-referentie & SDK's

Passinstance Documentatie voor Ontwikkelaars

Bouw grootschalige Apple Wallet (.pkpass) en Google Wallet integraties. Uitgeven, bijwerken, scannen en realtime meldingen versturen via productieklare REST-API's.

API-sleutels ophalen
Live docs-workbench — fragmenten worden bijgewerkt terwijl je typt
Dashboard-UI-tegenhanger
Belangrijke UI-onderdelen

Dashboard-tegenhanger: Aangepaste sleutels & validatieregels

De sleutelnamen in Custom properties (zoals holderName, validUntil) komen één-op-één overeen met de JSON-velden in de API.

Sjabloonbeheer

7 eindpunten
GEThttps://api.passinstance.com/api/v1/templatesAPI-sleutel
Sjabloonbeheer

Alle sjablonen weergeven

Haal een gepagineerde lijst met passjablonen op die behoren tot de geauthenticeerde klantwerkruimte.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Queryparameters3 optioneel

Antwoordstatuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}API-sleutel
Sjabloonbeheer

Sjabloongegevens ophalen

Haal volledige gegevens van een passjabloon op inclusief kleuren, streepjescode-instellingen, lay-outvelden en mechanicaregels.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idUUID
Vereist

Unieke sjabloonidentificatie.

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

Antwoordstatuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}/fieldsAPI-sleutel
Sjabloonbeheer

Sjabloonvelden ophalen

Haal de berekende dynamische velddefinities en aangepaste eigenschapssleutels op die per pas voor een sjabloon kunnen worden ingevuld.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Unieke sjabloon-UUID.

Voorbeeld: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
Queryparameters1 optioneel

Antwoordstatuscodes

POSThttps://api.passinstance.com/api/v1/templatesAPI-sleutel
Sjabloonbeheer

Passjabloon aanmaken

Ontwerp en registreer een herbruikbaar passjabloon met visuele branding, streepjescodetype, NFC-configuratie en lay-outvelden.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1

Sjabloonconfiguratie volgens het OpenAPI JSON-schema.

Aanvraagtekst6 vereist • 4 optioneel
namestring
Vereist

Weergavenaam van het sjabloon.

Voorbeeld: VIP Loyalty Card Template
descriptionstring
Vereist

Gedetailleerde beschrijving van het doel van de pas en niveauvoordelen.

Voorbeeld: Exclusive loyalty and rewards card for VIP customers
organizationNamestring
Vereist

Organisatie- / merknaam weergegeven in de kaartkop.

Voorbeeld: Acme Rewards
kindstring (enum)
Vereist

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

Voorbeeld: storeCard
statusstring (enum)
Vereist

DRAFT, PUBLISHED, ARCHIVED, DEPRECATED of UNDER_REVIEW.

Voorbeeld: PUBLISHED
preferredStyleSchemestring (enum)
Vereist

DARK, posterGeneric, posterEventTicket, bannerEventTicket of semanticBoardingPass.

Voorbeeld: DARK

Antwoordstatuscodes

POSThttps://api.passinstance.com/api/v1/templates/{id}/publishAPI-sleutel
Sjabloonbeheer

Sjabloonconcept publiceren

Promoveer een conceptrevisie (rowKind: DRAFT) naar PUBLISHED, markeer changesToPush: true en zet APNs- en Google Wallet-updates in de wachtrij voor alle actieve passen.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Sjabloon-UUID om te publiceren.

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

Verzoekpayload voor directe versus geplande publicatie en wallet-pushverspreiding.

Aanvraagtekst4 optioneel

Antwoordstatuscodes

POSThttps://api.passinstance.com/api/v1/templates/{id}/copyAPI-sleutel
Sjabloonbeheer

Sjabloon dupliceren

Kloon een bestaand passjabloon inclusief lay-out, kleuren, afbeeldingen en mechanieken binnen dezelfde klant-workspace.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Bron-sjabloon-UUID om te dupliceren.

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

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

Aanvraagtekst3 optioneel

Antwoordstatuscodes

DELETEhttps://api.passinstance.com/api/v1/templates/{id}API-sleutel
Sjabloonbeheer

Sjabloon verwijderen

Verwijder een passjabloon en start een asynchrone achtergrondtaak om gekoppelde passen in Apple Wallet en Google Wallet in te trekken.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Te verwijderen sjabloon-UUID.

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

Antwoordstatuscodes

Sjabloonmeldingen

3 eindpunten
POSThttps://api.passinstance.com/api/v1/push-notifications/templates/{id}/sendAPI-sleutel
Sjabloonmeldingen

Push verzenden naar alle passen van sjabloon

Verzend direct een pushmelding op het vergrendelscherm naar alle actieve Apple Wallet- en Google Wallet-passen onder een sjabloon.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Sjabloon-UUID waarvan de geregistreerde apparaten de melding ontvangen.

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

Verzoekpayload met pushNotificationText (max. 85 tekens) en optionele koptekst.

Aanvraagtekst1 vereist • 1 optioneel
pushNotificationTextstring
Vereist

Vergrendelschermmelding verzonden naar actieve passen (max. 85 tekens; ondersteunt variabelen).

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

Antwoordstatuscodes

GEThttps://api.passinstance.com/api/v1/templates/{id}/notificationAPI-sleutel
Sjabloonmeldingen

Geplande meldingen weergeven

Toon alle geplande en recent uitgevoerde pushmeldingscampagnes voor een specifiek passjabloon.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
idstring (UUID)
Vereist

Template UUID.

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

Antwoordstatuscodes

DELETEhttps://api.passinstance.com/api/v1/templates/notification/{notificationId}API-sleutel
Sjabloonmeldingen

Geplande melding annuleren

Annuleer een openstaande geplande sjabloon-pushmelding voordat deze naar geregistreerde apparaten wordt verzonden.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1
Padparameters1 vereist
notificationIdstring (UUID)
Vereist

UUID van de geplande melding geretourneerd bij het plannen of ophalen.

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

Antwoordstatuscodes

Sjabloonintegraties

2 eindpunten
POSThttps://api.passinstance.com/api/v1/integration-connections/embed-widgetsAPI-sleutel
Sjabloonintegraties

Embed-integratie aanmaken (iFrame)

Maak een insluitbare iFrame-widgetconfiguratie voor een gepubliceerd sjabloon om pasregistratie op uw website in te sluiten.

Headers (kopteksten)1 vereist
X-API-Keystring
Vereist

Geheime workspace-API-sleutel (pi_live_... of pi_test_...). U kunt ook Authorization: ApiKey <key> meesturen.

Voorbeeld: pi_live_98a7b6c5d4e3f2a1

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

Aanvraagtekst3 vereist • 1 optioneel
namestring
Vereist

Weergavenaam voor de embed-widgetintegratie.

Voorbeeld: Checkout Loyalty Embed Widget
templateIdstring (UUID)
Vereist

UUID van het doel-passjabloon.

Voorbeeld: 8f2a1e0b-3c4d-4e5f-9a1b-2c3d4e5f6a7b
allowedDomainsstring[]
Vereist

Lijst van toegestane origins (domeinen) die de widget mogen insluiten.

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

Antwoordstatuscodes