☰ Meniu · Scanări
Referință API
Scanări
Transformă orice a citit scanerul într-un membru și acțiunile disponibile pentru el.
POST
/v1/scansPermisiune: members:read sau devices:write
Găsește membrul din spatele valorii scanate și listează ce poate face dispozitivul în continuare. Nu se acumulează și nu se cheltuie nimic. Trimite evenimentul member.scanned. Întoarce 404 member_not_found dacă nu se potrivește nimic.
- codestring, obligatoriu
- Exact ce a produs scanerul: numărul cardului, conținutul QR, Code 128 cu sau fără prefixul
]C1, linkul paginii cardului sau un telefon. Sfârșiturile de rând și tab-urile sunt eliminate. - device_idstring
- Id-ul tău al dispozitivului, transmis mai departe în eveniment.
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" }'Răspuns · 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 | Înseamnă |
|---|---|
| visit | Programul recompensează vizitele: POST /v1/visits este permis. |
| transaction | Se poate aplica un bon cu POST /v1/transactions. |
| redeem_reward | O recompensă pentru ștampile așteaptă. path este apelul de făcut, available arată câte sunt. |
| redeem_cashback | Există sold. max_amount este soldul; plafonul per bon este redeem_max_percent. |