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.
Introductie — API-overzicht
Met de Passinstance API kunnen ontwikkelaars dynamisch digitale passen uitgeven, distribueren, bijwerken en valideren voor Apple Wallet (iOS) en Google Wallet (Android). Alle API-verzoeken verlopen via HTTPS en retourneren een gestandaardiseerde API-responsenvelop met machineleesbare statuscodes.
https://api.passinstance.com/api/v1https://staging-api.passinstance.com/api/v1Authenticatie — API-sleutels & autorisatie
Gebruik X-API-Key: <key> of Authorization: ApiKey <key> voor endpoints die API-sleutels ondersteunen. Bearer is bedoeld voor toegangs-JWT's. Bewaar inloggegevens op de server.
Authorization: ApiKey pi_live_xxxxxxxxxxxxxxxxxxxxxxxxAuthorization: ApiKey pi_test_xxxxxxxxxxxxxxxxxxxxxxxxx-scanner-key: scan_key_77a8b9c0d1e2f3a4...Snelstart — Eerste API-verzoek
Maak uw eerste bruikbare pas in minder dan 5 minuten. Stel uw API-sleutelheader in, roep POST /api/v1/passes aan met een geldige templateId en stuur de ontvangen passAccessUrl naar uw eindgebruiker.
export PASSINSTANCE_API_KEY="pi_test_..."POST /api/v1/passes met templateId en serialNumber
Haal response.data.passAccessUrl uit de 201 Created-respons
Stuur URL via sms/e-mail; gebruiker tikt op "Toevoegen aan Apple/Google Wallet"
Postman-collectie — API-verzoeken importeren & testen
Importeer de Passinstance OpenAPI 3.0-specificatie (/api/docs/openapi.json) rechtstreeks in Postman, Insomnia of Bruno om eindpunten te testen, schema's te inspecteren en getypeerde HTTP-clients te genereren.
https://passinstance.com/api/docs/openapi.jsonKlik op Import in Postman, Insomnia of Bruno en plak /api/docs/openapi.json om alle routes te laden
Stel baseUrl = https://api.passinstance.com en PASSINSTANCE_API_KEY = pi_test_... in
Voer GET /api/v1/templates uit met X-API-Key: om uw workspace te testen
FAQ — Veelgestelde vragen & foutafhandeling
Elke respons gebruikt de standaard API-responsenvelop. Los 4xx-fouten op voordat u het opnieuw probeert; wacht bij 5xx en 429 op basis van Retry-After.
{
"success": true,
"data": { ... },
"errors": [],
"statusCode": 200
}Architectuur & Levenscyclus van passen
Pasbeheer volgt een levenscyclus in 6 fasen: 1. Sjabloon (visuele blauwdruk) → 2. Pas (cryptografisch ondertekend record) → 3. Distributie (beveiligde passAccessUrl) → 4. Wallet-registratie (apparaat meldt zich aan bij APNs / Google Push) → 5. Live updates (realtime meldingen) → 6. Scan- & inwisseltelemetrie (validatie & webhook-stream).
POST /api/v1/templatesHoofdlay-out, streepjescodetype, merkkleuren en schemavelden
Apple Wallet vs. Google Wallet matrix
Passinstance ondertekent automatisch .pkpass-pakketten voor iOS en genereert ondertekende JWT-objecten voor Google Wallet. Afbeeldingen, streepjescodes en triggers passen zich automatisch aan beide besturingssystemen aan.
Cryptografische PKCS#7-handtekening met Apple Pass Type ID-certificaat
Google Cloud Service Account REST JWT-payload
Pasmechanica & Loyaliteitsoplossingen
Koppel stateful bedrijfsmechanica aan sjablonen voor 8 kant-en-klare oplossingen (Loyaliteit, Stempelkaarten, Coupons, Cadeau-/Prepaidkaarten, Evenementtickets, Lidmaatschappen, Personeelspassen, VIP-kaarten). Regels worden atomair uitgevoerd bij een scan of API-aanroep.
LOYALTY_PROGRAMLOYALTY_PROGRAM & Niveaus
Puntenopbouw per scan (defaultChangeValue) met automatische niveauverhoging
STAMP_CARDSTAMP_CARD_ADD / DEDUCT
Houdt stempelposities bij (0..maximumValue) met onCap ('noop' | 'reset') en rewardClaimBehavior
PREPAID_CARDPREPAID_CARD Grootboek
ISO 4217-grootboekadministratie voor prepaid in kleinste eenheden met disallowNegativeBalance-handhaving
VALID_ONCE_PER_DAYVALID_ONCE_PER_DAY & RENEW
Tijdzonebewuste dagelijkse inchecklimieten en automatische verlenging van expirationDate bij scan
Passinstance Helpcentrum: Bekijk alle 10 onderwerpen & 94 gidsen
Verken stapsgewijze handleidingen, workflow-architectuurdiagrammen, JSON-payloadschema's en probleemoplossing voor elk domein.
Alles wat u nodig hebt om vlot te starten met Passinstance.
Ontdek hoe digitale Wallet-kaarten aansluiten bij diverse sectoren.
Ontwerp, verstrek, orden en onderhoud uw digitale Wallet-kaarten.
Bezorg kaarten bij klanten en houd hun Wallets automatisch actueel.
Configureer Wallet-platformen, certificaten en NFC-mogelijkheden.
Controleer passen, beheer check-ins en verwerk klantbeloningen.
Koppel Passinstance aan uw systemen en automatiseer werkprocessen.
Volg prestaties, bekijk activiteiten en meet het gebruik van kaarten.
Beheer organisatie, teamleden, abonnement en factuurinstellingen.
Vind antwoorden, los storingen op en neem contact op met support.
