☰ Menü · Genel bakış
Başlarken

Loyaltyfy API

Yazarkasanızı, randevu sisteminizi, kioskunuzu ya da kendi uygulamanızı Loyaltyfy sadakat kartlarına, QR menülere ve masa siparişlerine bağlayın.

Loyaltyfy restoran, kafe, mağaza ve salonlar için sadakat programları ve dijital menüler sunar. Misafir kartını Apple Wallet veya Google Wallet'ta taşır, işletme her ziyareti ve her fişi görür. API, işletmenin zaten kullandığı sistemleri bu akışa dahil eder: kasa kapanan fişe cashback ekler, girişteki kiosk ziyarete damga basar, randevu sistemi gerçekleşen randevuyu ödüllendirir, POS misafirlerin QR menüden gönderdiği siparişleri alır.

HTTPS üzerinden çalışan sade bir REST API'dir. İstekler ve yanıtlar JSON formatındadır, tutarlar en küçük para biriminde tam sayıdır (12500 = 125,00), zamanlar ISO 8601 biçimindedir. Her işletmenin kendi anahtarları vardır, bu yüzden tek bir entegrasyon istediğiniz sayıda işletmede çalışır: her işletme için bir anahtar saklar ve her istekte onu gönderirsiniz.

Nereden başlamalı

Temel URL

Tüm uç noktalar https://loyaltyfy.io/api/v1 altındadır. Bu dokümantasyondaki yollar /v1 ile başlar, yani GET /v1/members aslında GET https://loyaltyfy.io/api/v1/members demektir.

Temel nesneler

NesneNedir
memberİşletmenin sadakat programına kayıtlı, tek bir Wallet kartı olan misafir. Kart numarası, barkod, telefon veya id ile bulunur.
transactionKasanın gönderdiği kapanmış bir fiş. Cashback veya damga kazandırır, cashback harcatabilir, iptal edilebilir.
visitKiosk, tarayıcı veya randevu sisteminden gelen, fişsiz bir giriş kaydı.
menu, menu_itemİşletmenin QR menüsü: kategoriler, ürünler, opsiyonlar, fiyatlar, tükenenler listesi.
orderMisafirin masadan QR menü üzerinden gönderdiği sepet. POS siparişi kabul eder ve durumlar arasında ilerletir.
eventGerçekleşen bir olay (fiş işlendi, sipariş verildi). Webhook uç noktanıza gönderilir.

Sonraki adım

İlk isteğinizi Hızlı başlangıç sayfasında yapın. Test anahtarıyla yaklaşık beş dakika sürer.

Entegrasyonla ilgili sorularınız için: api@loyaltyfy.io. Bir iş günü içinde yanıt veriyoruz.