Anahtarlar ve izinler

Her istek, Authorization başlığında gizli bir anahtar taşır. Anahtar tek bir işletmeye aittir ve entegrasyonun ihtiyacı kadar yetkiyle sınırlandırılabilir.

curl

curl https://loyaltyfy.io/api/v1/account \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc"

Anahtarı Authorization: Bearer <key> olarak gönderin. Anahtarsız, tanınmayan veya iptal edilmiş anahtarla gelen istekler 401 alır.

Test ve canlı anahtarlar

Anahtarlar sk_test_ veya sk_live_ ile başlar. İkisi de aynı işletme ve aynı veriler üzerinde çalışır. Fark, anahtarın oluşturduğu her kayıttaki livemode bayrağıdır: raporlar ve webhook'lar test trafiğini bu sayede ayırt eder. Geliştirme sırasında test anahtarı kullanın, ilk gerçek vardiyada canlı anahtara geçin.

İzinler (scopes)

Bir anahtar belirli izinlerle sınırlandırılabilir. Anahtarda olmayan bir izni gerektiren istek, missing_scope koduyla 403 alır. İzin seçilmeden oluşturulan anahtar tam erişime sahiptir. Bunu yalnızca işletmenin kendi script'leri için öneriyoruz.

İzin	Neye izin verir
members:read	Üye arama, listeleme, geçmişi okuma, kod tarama.
members:write	Üye kaydetme, profil güncelleme, kart numarası atama.
members:adjust	İşletme izin veriyorsa, bir neden belirterek elle cashback ekleme veya düşme.
transactions:write	Fiş işleme ve iptal etme, ziyaret kaydetme, ödül verme, işlemleri listeleme.
menu:read	Menüyü ve ürünleri okuma.
menu:write	Ürün oluşturma, fiyat değiştirme, tükenenler listesini yönetme.
orders:read	Masa siparişlerini okuma.
orders:write	Siparişleri kabul etme, reddetme ve durumlar arasında ilerletme.
devices:write	Kiosk ve tarayıcı paketi: tarama, ziyaret, üye kaydı ve ödül verme. Üye listesine ve fişlere erişim yoktur.
catalog:read	Ürünleri ve kategori kurallarını okuma.
catalog:write	Ürün yükleme ve kategorilere ad verme. Kategorilerin para kuralları işletme sahibinde kalır.
webhooks:write	Webhook uç noktalarını yönetme.

Tipik kombinasyonlar: kasa için members:read, members:write, transactions:write. Giriş tarayıcısı için yalnızca devices:write. Menü senkronizasyonu için menu:read ve menu:write. POS masa siparişi de alacaksa orders:read ve orders:write ekleyin.

Anahtarların güvenliği

Anahtarlar gizlidir. API'yi kendi sunucunuzdan veya kasanın arka ofisinden çağırın, asla tarayıcıdan veya herkese açık bir mobil uygulamadan çağırmayın.
Her anahtarın yalnızca hash'ini saklarız. Anahtar kaybolursa panelden iptal edip yenisini oluşturun. Değişiklik hemen geçerli olur.
Mümkünse her kurulum için ayrı anahtar kullanın (her kasa, her kiosk için bir tane). Böylece birini iptal etmek diğerlerini durdurmaz, paneldeki Son kullanım bilgisi de hangi cihazın istek gönderdiğini gösterir.