Сканерлеу

Сканер оқыған кез келген мәннен қатысушыны және оған қолжетімді әрекеттерді алыңыз.

POST/v1/scans

Құқық: members:read немесе devices:write

Сканерленген мән бойынша қатысушыны тауып, құрылғы әрі қарай не істей алатынын тізімдейді. Ештеңе есептелмейді және жұмсалмайды. member.scanned оқиғасын жібереді. Сәйкестік табылмаса, 404 member_not_found қайтарады.

codestring, міндетті: Сканер берген мәннің дәл өзі: карта нөмірі, QR мазмұны, ]C1 префиксі бар немесе жоқ Code 128, карта бетінің сілтемесі немесе телефон. Жол ауыстырулар мен табуляциялар алынып тасталады.
device_idstring: Құрылғының сіздегі id-і, оқиғаға беріледі.

Параметр	Түрі	Сипаттама
code	string, міндетті	Сканер берген мәннің дәл өзі: карта нөмірі, QR мазмұны, `]C1` префиксі бар немесе жоқ Code 128, карта бетінің сілтемесі немесе телефон. Жол ауыстырулар мен табуляциялар алынып тасталады.
device_id	string	Құрылғының сіздегі 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`.