LLoyaltyfyAPI v1
EL
☰ Μενού · Σαρώσεις
Αναφορά API

Σαρώσεις

Μετατρέψτε ό,τι διάβασε ένας σαρωτής σε μέλος και στις ενέργειες που είναι διαθέσιμες γι' αυτό.

POST/v1/scans
Δικαίωμα: members:read ή devices:write

Βρίσκει το μέλος πίσω από μια σαρωμένη τιμή και απαριθμεί τι μπορεί να κάνει στη συνέχεια η συσκευή. Δεν κερδίζεται ούτε ξοδεύεται τίποτα. Στέλνει το συμβάν member.scanned. Επιστρέφει 404 member_not_found αν δεν υπάρχει αντιστοιχία.

codestring, υποχρεωτικό
Ακριβώς ό,τι έδωσε ο σαρωτής: αριθμός κάρτας, περιεχόμενο QR, Code 128 με ή χωρίς το πρόθεμα ]C1, σύνδεσμος σελίδας κάρτας ή τηλέφωνο. Οι αλλαγές γραμμής και τα tabs αφαιρούνται.
device_idstring
Το δικό σας id της συσκευής, που μεταφέρεται στο συμβάν.
curl
curl https://loyaltyfy.io/api/v1/scans \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{ "code": "]C14285324286429\r", "device_id": "door-1" }'
Απάντηση · 200
{
  "object": "scan",
  "matched": true,
  "matched_by": "4285324286429",
  "device_id": "door-1",
  "mechanic": "stamps",
  "member": {
    "object": "member",
    "card_number": "4285324286429",
    "first_name": "Ana",
    "stamps": { "current": 1, "required": 5, "rewards_available": 0 },
    ...
  },
  "actions": [
    { "type": "visit", "method": "POST", "path": "/v1/visits" },
    { "type": "transaction", "method": "POST", "path": "/v1/transactions" }
  ]
}
action.typeΣημασία
visitΤο πρόγραμμα επιβραβεύει επισκέψεις: επιτρέπεται το POST /v1/visits.
transactionΜπορεί να καταχωριστεί απόδειξη με POST /v1/transactions.
redeem_rewardΥπάρχει επιβράβευση σφραγίδων σε αναμονή. Το path είναι η κλήση που πρέπει να κάνετε, το available πόσες υπάρχουν.
redeem_cashbackΥπάρχει υπόλοιπο. Το max_amount είναι το υπόλοιπο· το όριο ανά απόδειξη είναι το redeem_max_percent.