☰ Menü · Ziyaretler
API referansı
Ziyaretler
Damga ve ziyaret programları için fişsiz giriş kaydı.
POST
/v1/visitsİzin: transactions:write veya devices:write
Bir ziyaret kaydeder ve programın ziyaret başına ödülünü verir. object: "visit" ve amount: 0 içeren, işleme benzer bir nesne döndürür. Aynı external_id tekrar gönderilirse kayıtlı ziyaret 200 ile döner. Cashback programları 400 visit_not_supported yanıtı verir.
- external_idstring, zorunlu
- Bu giriş kaydının sizdeki id'si. İşlemlerle aynı ad alanını paylaşır.
- memberstring, zorunlu
- Üyeyi tanımlayan herhangi bir değer, tarayıcıdan gelen ham değer dahil.
- device_idstring
- Kaydı yapan cihaz. Raporlarda kasa olarak gösterilir.
- visited_atdatetime
- Ziyaretin zamanı. Varsayılan: şimdi.
curl
curl https://loyaltyfy.io/api/v1/visits \
-H "Authorization: Bearer sk_test_..." \
-H "Content-Type: application/json" \
-d '{
"external_id": "door-1-2026-10-06-0042",
"member": "4285324286429",
"device_id": "door-1"
}'Yanıt · 201
{
"object": "visit",
"id": "feb2ad75-ac7b-4bb6-8b64-192323b7f6ea",
"external_id": "door-1-2026-10-06-0042",
"status": "completed",
"amount": 0,
"stamps_earned": 1,
"reward_unlocked": false,
"register_id": "door-1",
"livemode": false,
"created_at": "2026-10-06T18:17:28.209+00:00",
"member": {
"object": "member",
"card_number": "4285324286429",
"stamps": { "current": 2, "required": 5, "rewards_available": 0 },
...
},
...
}Ziyaret, fiş gibi iptal edilebilir: POST /v1/transactions/{external_id}/void.