☰ Menü · Genel bakış
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ı
Misafiri kart, telefon veya barkodla bulun, fiş işleyin, cashback harcatın, iadeyi iptal edin, kendi numaralarınızla kart çıkarın.
Fiyatları ve tükenenler listesini senkronize edin, masadan sipariş alın, kafe kasasında sadakat programını çalıştırın.
Her taramayı bir üyeye ve izin verilen işlemler listesine dönüştürün. Misafirleri tablette kaydedin. Fiş olmadan ziyarete damga basın.
Gerçekleşen randevuları ödüllendirin, müşterileri senkronize edin, hazır Altegio entegrasyonunun bunu nasıl yaptığına bakın.
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
| Nesne | Nedir |
|---|---|
| member | İşletmenin sadakat programına kayıtlı, tek bir Wallet kartı olan misafir. Kart numarası, barkod, telefon veya id ile bulunur. |
| transaction | Kasanın gönderdiği kapanmış bir fiş. Cashback veya damga kazandırır, cashback harcatabilir, iptal edilebilir. |
| visit | Kiosk, 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. |
| order | Misafirin masadan QR menü üzerinden gönderdiği sepet. POS siparişi kabul eder ve durumlar arasında ilerletir. |
| event | Gerç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.