Wallet Passes API
Τα wallet passes (Apple Wallet και Google Wallet) εκδίδονται και διαχειρίζονται από τον πίνακα ελέγχου και τα journeys του Joryio. Αυτό το API καλύπτει το ένα βήμα που συμβαίνει εκτός Joryio: την καταγραφή της στιγμής που ένα pass σαρώνεται/εξαργυρώνεται στο σημείο πώλησής σας.
Αυτή η σάρωση είναι που τροφοδοτεί το στάδιο Σαρώθηκαν του χωνιού υιοθέτησης Wallet και το Ποσοστό σάρωσης στο Analytics -> Wallet Analytics. Ούτε η Apple ούτε η Google ειδοποιούν το Joryio όταν ένα pass χρησιμοποιείται στο κατάστημα, οπότε το POS σας (ή μια ενδιάμεση ενσωμάτωση) πρέπει να στείλει τη σάρωση εδώ.
Έλεγχος ταυτότητας
Όλα τα αιτήματα χρησιμοποιούν ένα κλειδί API ως bearer token και απαιτούν το δικαίωμα wallet:write:
Authorization: Bearer jry_live_xxxxxxxxxxxxxxxxxxxx
Καταγραφή σάρωσης / εξαργύρωσης pass
POST /wallet-passes/scan
| Πεδίο | Τύπος | Σημειώσεις |
|---|---|---|
serialNumber | string | Υποχρεωτικό. Το μοναδικό αναγνωριστικό του pass, που διαβάζεται από το barcode/QR που είναι τυπωμένο στο pass. |
properties | object | Προαιρετικό. Ελεύθερα μεταδεδομένα εξαργύρωσης (κατάστημα, ποσό, ταμίας, ...). Αποθηκεύεται ως έχει στο συμβάν pass.scanned και είναι διαθέσιμο στα analytics. |
Παράδειγμα
TOKEN=jry_live_xxxxxxxxxxxxxxxxxxxx
BASE=https://api-eu1.joryio.com
curl -sX POST "$BASE/wallet-passes/scan" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"serialNumber": "a1b2c3d4-e5f6-4789-abcd-1234567890ab",
"properties": { "storeId": "store_42", "amount": 19.90, "currency": "EUR" }
}'
Απόκριση
{ "recorded": true }
Το recorded είναι false όταν δεν υπάρχει pass με αυτό το serialNumber στον οργανισμό σας - σε αυτήν την περίπτωση δεν καταγράφεται τίποτα.
Σημειώσεις
- Idempotent ανά pass για τα analytics. Το χωνί μετρά μοναδικά passes, οπότε η επανασάρωση του ίδιου
serialNumberμετρά ακόμα ως ένα σαρωμένο pass. Κάθε κλήση εκπέμπει το δικό της συμβάνpass.scanned, οπότε ταpropertiesκάθε σάρωσης διατηρούνται. - Τι είναι το serial. Το
serialNumberείναι το αναγνωριστικό του pass που κωδικοποιείται στο barcode/QR του pass. Διαβάστε το στο ταμείο και στείλτε το αυτούσιο. - Πού εμφανίζεται. Οι σαρώσεις τροφοδοτούν τη ροή συμβάντων
pass.scannedκαι το στάδιο Σαρώθηκαν / Ποσοστό σάρωσης στο Wallet Analytics. Το ποσοστό σάρωσης υπολογίζεται ως scanned / downloaded (καθαρή cross-platform βάση). - Κλειδιά πολλαπλών workspaces. Αν το κλειδί API σας εκτείνεται σε πολλά workspaces, προσθέστε μια κεφαλίδα
X-Workspace-Id: <workspace-id>. Είναι προαιρετική για κλειδί ενός μόνο workspace.