Taramalar

Tarayıcının okuduğu değeri bir üyeye ve o üye için yapılabilecek işlemlere dönüştürün.

POST/v1/scans

İzin: members:read veya devices:write

Okunan değerin arkasındaki üyeyi bulur ve cihazın sonraki adımda yapabileceklerini listeler. Hiçbir şey kazanılmaz veya harcanmaz. member.scanned olayını gönderir. Eşleşme yoksa 404 member_not_found döndürür.

codestring, zorunlu: Tarayıcının ürettiği değerin aynısı: kart numarası, QR içeriği, ]C1 önekli veya öneksiz Code 128, kart sayfası bağlantısı ya da telefon. Satır sonları ve sekmeler temizlenir.
device_idstring: Cihazın sizdeki id'si, olaya aynen aktarılır.

Parametre	Tür	Açıklama
code	string, zorunlu	Tarayıcının ürettiği değerin aynısı: kart numarası, QR içeriği, `]C1` önekli veya öneksiz Code 128, kart sayfası bağlantısı ya da telefon. Satır sonları ve sekmeler temizlenir.
device_id	string	Cihazın sizdeki id'si, olaya aynen aktarılır.

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" }'

Yanıt · 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	Anlamı
visit	Program ziyaretleri ödüllendirir: `POST /v1/visits` kullanılabilir.
transaction	`POST /v1/transactions` ile fiş işlenebilir.
redeem_reward	Bekleyen bir damga ödülü var. `path` yapılacak istek, `available` kaç adet olduğu.
redeem_cashback	Bakiye var. `max_amount` bakiyedir, fiş başına limit `redeem_max_percent` değeridir.