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
Beveiliging

Overzicht — Hoe pasvalidatie werkt

Elke barcode- of NFC-scan doorloopt een deterministische validatiepijplijn van 14 regels (status, vervaldatum, tijdvensters, geofencing, mechanica, snelheidslimieten, anti-replay) met optionele cryptografische nonces en offline datasetsynchronisatie.

Anti-replay Nonce

POST /api/v1/scans/prepare geeft een kortlevende cryptografische anti-replay nonce uit gekoppeld aan de barcode

14-regels pijplijn

PassStatus → Expiration → TimeWindow → Geofencing → Mechanics → RateLimit → AntiReplay

Offline dataset-sync

GET /api/v1/scans/offline-dataset biedt cursor-gepagineerde snapshots voor offline terminals

Scannersleutel koppelen

POST /api/v1/scanner-keys/from-link wisselt een koppelingstoken + pincode in voor een x-scanner-key

Scannerconfiguratie

3 eindpunten
GEThttps://api.passinstance.com/api/v1/validation/configsAPI-sleutel
Scannerconfiguratie

Scannerconfiguraties weergeven

Toon alle geconfigureerde scannerprofielen (mobiele app, webscanner, kassa) en hun sjabloonmachtigingen in uw 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
Queryparameters2 optioneel

Antwoordstatuscodes

GEThttps://api.passinstance.com/api/v1/validation/configs/{id}API-sleutel
Scannerconfiguratie

Scannerconfiguratie ophalen

Haal de details op van één scannerconfiguratie, inclusief toegestane sjablonen, bericht na scan en validatieregels.

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

UUID van de scannerconfiguratie.

Voorbeeld: 7a8b9c0d-1e2f-4a3b-8c9d-0e1f2a3b4c5d

Antwoordstatuscodes

POSThttps://api.passinstance.com/api/v1/validation/configsAPI-sleutel
Scannerconfiguratie

Scannerconfiguratie aanmaken

Maak een nieuw scannerconfiguratieprofiel aan met gekoppelde sjablonen, standaard scanactie en bevestigingsbericht.

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

Scanner configuration profile name, allowed template UUIDs, scan mode, and optional cooldown window.

Aanvraagtekst2 vereist • 2 optioneel
namestring
Vereist

Leesbare naam voor de scannerconfiguratie.

Voorbeeld: Main Entrance Gate Scanners
templateIdsstring[] (UUID)
Vereist

Sjabloon-UUID's die onder dit profiel mogen worden gevalideerd.

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

Antwoordstatuscodes

Scanoperaties

4 eindpunten
GEThttps://api.passinstance.com/api/v1/validation/scansAPI-sleutel
Scanoperaties

Scanrecords weergeven

Haal het gepagineerde auditlogboek van passcans op, gefilterd op sjabloon, pas-ID, scannerconfiguratie, beslissing en datumbereik.

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

POSThttps://api.passinstance.com/api/v1/scansScannersleutel
Scanoperaties

Barcode- / NFC-scan verwerken

Valideer een optische streepjescode, QR-code of Apple VAS / Google Smart Tap NFC-scan vanaf een terminal of mobiele scanner via de 14-regels validatie-engine.

Headers (kopteksten)2 vereist • 2 optioneel
x-scanner-keystring
Vereist

Gekoppelde scannerconfiguratiesleutel aangemaakt in het Dashboard of via een koppelingslink.

Voorbeeld: scan_key_77a8b9c0d1e2f3a4b5c6d7e8
Content-Typestring
Vereist

Moet application/json zijn.

Voorbeeld: application/json

Verzoekpayload met gescande streepjescode, optionele anti-replay nonce, kanaal-/protocolmetadata en operatorcontext.

Aanvraagtekst1 vereist • 8 optioneel
scannedBarcodeValuestring
Vereist

De ruwe tekenreeks gelezen van QR-code, PDF417, CODE128, AZTEC of NFC-tap.

Voorbeeld: PI-8891-JD-VIP

Antwoordstatuscodes

POSThttps://api.passinstance.com/api/v1/scans/prepareScannersleutel
Scanoperaties

Anti-replay scan-nonce voorbereiden

Geef een kortlevende cryptografische anti-replay nonce gebonden aan een streepjescode uit vóór het uitvoeren van POST /api/v1/scans.

Headers (kopteksten)1 vereist
x-scanner-keystring
Vereist

Gekoppelde scannerconfiguratiesleutel aangemaakt in het Dashboard of via een koppelingslink.

Voorbeeld: scan_key_77a8b9c0d1e2f3a4b5c6d7e8

Verzoekpayload met de gescande streepjescodewaarde om de cryptografische nonce aan te koppelen.

Aanvraagtekst1 vereist
scannedBarcodeValuestring
Vereist

Streepjescode- of NFC-tokenreeks waaraan de anti-replay nonce wordt gekoppeld.

Voorbeeld: PI-8891-JD-VIP

Antwoordstatuscodes

GEThttps://api.passinstance.com/api/v1/scans/offline-datasetScannersleutel
Scanoperaties

Offline scannerdataset ophalen

Download een cursor-gepagineerde pas-snapshotdataset binnen het bereik van de x-scanner-key voor lokale offline validatie wanneer de netwerkverbinding wegvalt.

Headers (kopteksten)1 vereist
x-scanner-keystring
Vereist

Gekoppelde scannerconfiguratiesleutel aangemaakt in het Dashboard of via een koppelingslink.

Voorbeeld: scan_key_77a8b9c0d1e2f3a4b5c6d7e8
Queryparameters3 optioneel

Antwoordstatuscodes