Yazarkasanız ya da programınız siparişlerinizi okuyabilsin.
API anahtarıyla dış sistem menünüzü, siparişlerinizi ve gün sonu cironuzu okur; imzalı bildirimle yeni siparişten anında haberdar olur. API salt okunurdur: dışarıdan sipariş oluşturmaz.
Kasanız ile panel aynı rakamı görsün.
Siparişleri iki yere elle yazmak hata getirir. Dış sistem okur, siz tek yerden çalışırsınız.
Okuma uçları
Menü, ürünler, masa durumu, masa siparişleri, eve siparişler ve gün sonu ciro özeti. Hepsi yalnız okunur.
Webhook bildirimi
Yeni sipariş, durum değişikliği, hesap isteği ve hesap kapanışında verdiğiniz https adresine bildirim gider. Dış sistem sürekli sorgu atmak zorunda kalmaz.
Anahtar sizde
Anahtarı panelden siz açar, durdurur, silersiniz. İşletme başına en fazla 10 anahtar tanımlanır; her sistem için ayrı anahtar vermek en doğrusudur.
Üç adımda bağlanır.
Anahtar oluşturun
Panelde Yazarkasa ve API sayfasından bağlantıya bir ad verirsiniz (örneğin "Yazarkasa"). Anahtar ve imza sırrı bir kez gösterilir.
Firmaya verin
Anahtarı ve sayfadaki entegrasyon rehberini yazılımı kuran firmaya iletin. Rehber, ona gereken her şeyi içerir.
Deneyin, izleyin
Panelden deneme bildirimi gönderebilir, anahtarın son kullanım zamanını görebilirsiniz.
Teknik özet
Bu bölüm entegrasyonu yazan kişi içindir. Her isteğe anahtarı X-API-Key başlığı olarak ekleyin; Authorization: Bearer biçimi de kabul edilir.
curl -H "X-API-Key: qrs_xxxxxxxx" https://qrsystema.com/api/v1/me| Adres | Ne döner |
|---|---|
GET /api/v1/me | İşletme bilgisi; bağlantı testi için |
GET /api/v1/menu | Kategoriler, ürünler, porsiyonlar, ilaveler, fiyatlar |
GET /api/v1/products/{id} | Tek ürün |
GET /api/v1/tables | Açık masalar ve birikmiş tutarlar |
GET /api/v1/orders | Masa siparişleri; durum ve tarih süzgeci, sayfalama |
GET /api/v1/orders/{id} | Tek sipariş, kalem kalem |
GET /api/v1/delivery-orders | Eve siparişler |
GET /api/v1/sales/summary | Gün sonu: masa ve paket cirosu, nakit ve kart dağılımı |
Anahtar başına dakikada 120 istek sınırı vardır; aşılırsa 429 döner. Listeler page ve pageSize ile sayfalanır (en fazla 200). Tanınmayan anahtarla art arda deneme yapan adres geçici olarak kilitlenir.
Webhook
Bildirim adresi https olmalıdır; yönlendirme izlenmez. Olaylar: order.created, order.updated, order.status_changed, bill.requested, bill.closed, delivery.created, delivery.status_changed ve deneme için test.ping. Her bildirimde X-QRS-Signature başlığı gelir: gövdenin, imza sırrınızla üretilmiş HMAC-SHA256 özeti. Dış sistem bunu doğrulayarak isteğin bizden geldiğini anlar.
Karşı taraf 2xx dönmezse bildirim artan aralıklarla (30 saniyeden 8 saate kadar, en fazla 10 deneme) yeniden gönderilir. Aynı bildirim iki kez ulaşabilir; her bildirimin sabit bir kimliği vardır, tekrarı o kimlikle ayıklayın.
Dürüst sınırlar.
- API salt okunurdur; sipariş oluşturamaz, hesap kapatamaz, menüyü değiştiremez.
- Hazır yazarkasa eklentisi ya da belirli bir cihazla uyum sözü vermiyoruz; entegrasyon, cihazın yazılımını yazan firma tarafından yapılır.
- Resmi mali işlemler (fiş, Z raporu, e-belge) QRSystema'nın işi değildir; bunlar yazarkasanın kendi görevi olarak kalır.
- Webhook garanti teslim değil, tekrar deneyen bir kuyruktur. Dış sistem kesintideyse ve sınır dolarsa bildirim bırakılır; kaçan siparişleri API'den okumak gerekir.
- İmza sırrı yenilenirse eski sırla doğrulama kopar; yenisini dış sisteme hemen girmelisiniz.
- Panelde Yazarkasa ve API sayfasındaki rehber esastır; uç ya da alan eklenirse güncel hâli orada yazar.
API hakkında kısa yanıtlar.
API ile dışarıdan sipariş verebilir miyim?
Hayır. İşletmenin açtığı API anahtarı salt okunurdur: menüyü, siparişleri ve ciro özetini okur. Sipariş oluşturamaz, hesap kapatamaz, fiyat değiştiremez. Kasada yapılan işlem yine QRSystema panelinden yürür.
Anahtarı kaybedersem ne olur?
Anahtar yalnız oluşturulduğu anda bir kez gösterilir; sistemde yalnız şifrelenmiş özeti durur. Kaybederseniz eskisini silip yenisini oluşturursunuz.
Yazarkasa firmam bunu kullanabilir mi?
Teknik olarak HTTP ile okuma yapabilen her sistem kullanabilir. Anahtarı ve bu sayfadaki uç listesini firmaya verirsiniz. Belirli bir yazarkasa modeliyle uyumlu olduğunu önceden söylemiyoruz; entegrasyonu yazan firma denemelidir.
Kaç anahtar açabilirim?
İşletme başına en fazla 10 anahtar. Her yazılım için ayrı anahtar vermek en doğrusudur: biri sızarsa ya da firmayla işiniz biterse yalnız onu silersiniz, ötekiler çalışmaya devam eder. Silinen anahtar kalıcı olarak iptal edilir, geri açılmaz; durdurulan ise yeniden açılabilir.
Tarih süzgecinde saat dilimi nasıl okunur?
Saat dilimi yazmazsanız işletme saati kabul edilir. Zaman damgasının sonuna Z koyarsanız UTC okunur. Sipariş yanıtındaki oluşturulma zamanı UTC olarak döner (sonunda Z vardır).
Webhook nedir, zorunlu mu?
Yeni sipariş ya da hesap kapanışı olduğunda sizin verdiğiniz adrese küçük bir bildirim gönderilmesidir. Zorunlu değildir; adres girmezseniz dış sistem siparişleri kendisi sorgulayarak okur.
DoyHadi bağlantısı bu anahtarlardan mı?
DoyHadi kendi ayrı anahtarıyla bağlanır ve o anahtarı DoyHadi bağlantısı yönetir. İşletmenin açtığı yazarkasa anahtarlarından ayrıdır; panelde DoyHadi etiketiyle görünür.
Bunlar da ilginizi çekebilir
Kasa ve tahsilat
Adisyon, nakit ve kart tahsilatı, hesabı bölme, geçmiş ve eksik ödeme uyarısı.
ÖzelliklerOku
İstatistik ve raporlar
Ciro, sipariş, en çok satanlar, saatlik yoğunluk, ziyaretçi ve menü gezinti analizi.
ÖzelliklerOku
Eve sipariş ve DoyHadi
DoyHadi üzerinden gelen siparişler aynı panelde onaylanır, hazırlanır ve kuryeye verilir.
ÖzelliklerOkuİşletmenizi bugün açalım.
Kurulum ücreti yok. Menünüzü girin, masa karekodlarınızı yazdırın, ilk siparişi aynı gün alın.