Sözlük

HummyTummy API’sinde ve dokümantasyonda sık geçen terimlerin kısa tanımları.

Tenant

Bir restoran işletmesini (müşteri hesabı) temsil eden en üst düzey kiracı. Lisansın, satın alınan katalog ürünlerinin ve tüm verinin sahibidir. Tenant çözümlemesi host adına göre değil, JWT içindeki tenantId üzerinden yapılır.

Branch (Şube)

Bir tenant’a ait fiziksel konum/şube. Masalar, siparişler, stok ve çoğu operasyonel veri şubeye bağlıdır. Şubeye-özel uç noktalar X-Branch-Id başlığını gerektirir.

Rol

Bir kullanıcının yetki düzeyi. Roller: ADMIN, MANAGER, WAITER, KITCHEN, COURIER. WAITER, KITCHEN ve COURIER “sert kısıtlı” rollerdir — tek bir şubeye sabitlenirler (primaryBranchId zorunludur) ve başka bir şubeyi hedefleyemezler.

KDS (Kitchen Display System)

Mutfak ekran sistemi. Gelen siparişleri mutfak/hazırlık istasyonlarına gerçek zamanlı yansıtan ekran. kdsIntegration özelliğine bağlıdır.

POS (Point of Sale)

Satış noktası — sipariş alma, ödeme ve masa yönetiminin yapıldığı kasa arayüzü. posAccess özelliğine bağlıdır.

QR menü

Müşterinin masadaki QR kodu okutarak eriştiği genel menü ve sipariş arayüzü. Bir QR oturumu (ordering session) üzerinden sipariş ve self-pay akışlarını besler.

Self-pay

Müşterinin garson aracılığı olmadan, kendi cihazından (veya masa ekranından) hesabını ödemesi. PayTR hosted-iframe ödeme niyeti oluşturularak yürütülür; payments:write scope’u gerektirir.

Scope

Bir partner API anahtarının ve ekran token’ının taşıdığı izin birimi (ör. menu:read, orders:write). Her /display uç noktası belirli bir scope ister. Bkz. Partner Scope’ları.

Screen token (Ekran token’ı)

Bir partner API anahtarından üretilen, belirli bir ekran/cihaz oturumuna (screen session) bağlı erişim token’ı. Bir tenant’a, isteğe bağlı bir masaya ve bir şubeye bağlıdır; efektif scope’ları üst anahtarın bir alt kümesidir.

Webhook

Sunucudan dışa doğru gönderilen olay bildirimi. Örneğin PayTR ödeme sağlayıcısının ödeme sonucunu bildirdiği geri-çağrı; ödeme yalnızca webhook onayından sonra provizyonlanır (confirmAndProvision).

Outbox

Veritabanı işlemiyle aynı transaction içinde yazılan, ardından güvenilir biçimde yayımlanan olay kaydı deseni. Yan etkilerin (olay yayını) ana veriyle atomik olmasını ve “en az bir kez” teslimi sağlar.

Entitlement (Hak)

Bir tenant’ın ücretsiz çekirdeğinden ve satın aldığı katalog ürünlerinden türetilen efektif özellik, limit ve entegrasyon kümesi. feature.* OR, limit.* SUM, integration.* UNION ile katlanır; bir ürün alındığında, iptal edildiğinde veya süresi dolduğunda yeniden hesaplanır (re-projeksiyon). Kapılar @RequireEntitlement üzerinden bu kümeye bakar; eksikse 403 ENTITLEMENT_REQUIRED döner. Bkz. Yetki Matrisi.

Katalog ürünü (Add-on)

Ücretsiz çekirdeğin üzerine ayrı satın alınan modül, entegrasyon, kapasite, kontör paketi veya hizmet. Marketplace kataloğunda tanımlıdır, PayTR checkout rayı ile satın alınır ve ödeme onaylandıktan sonra grants haritası entitlement’a katılır. Veritabanı tarafındaki sahiplik satırı TenantAddOn’dur.

Lisans

Ücretli her yeteneğin ön koşulu olan yıllık ürün (license_annual). Hem satın almak hem kullanmak için gerekir: lisans canlı değilken requiresLicense taşıyan her ürünün grant’ları karartılır — sahiplik satırları ve iş verisi silinmez, lisans ödenince aynen geri açılır.

Kontör (Credit)

Ön ödemeli tüketim bakiyesi (PHOTO, VIDEO, MODEL3D, SMS). Entitlement değildir: tek seferlik paketlerle alınır, süresi yoktur ve tükenene kadar geçerlidir. Bakiye, harcama anında canlı okunur; yetersizse 402 QUOTA_EXCEEDED döner.

Yıl dönümü (Anniversary)

Lisansın alındığı tenant-yerel takvim günü; hesabın değişmez yenileme tarihi. Sonradan alınan her yıllık kalem bu tarihe kalan gün kadar orantılı fiyatlanır, böylece tüm hesap tek tarihte tek faturayla yenilenir. Yenileme manueldir; kayıtlı kart ve otomatik tahsilat yoktur.