API referansı
Cibusy API'nin tüm uç noktaları: mekanlar, menü, masalar, siparişler, rezervasyonlar ve webhook testi; parametreleri, alanları, hata kodları ve beş dilde kod örnekleriyle.
Cibusy API, JSON konuşan bir REST API'dir. Her istek HTTPS üzerinden şu temel adrese gider:
https://api.cibusy.com/public/v1Her çağrı mekanın API anahtarını X-Api-Key başlığında taşır; anahtarı Kimlik doğrulama rehberinde anlatıldığı gibi yalnız sunucunuzda kullanın. Yanıtların zarfı, zaman ve para biçimleri İstekler ve yanıtlar rehberinde, hata kodlarının tamamı Hatalar rehberinde.
Uç noktaların alanları API'nin OpenAPI belgesinden gelir. Belgeyi bir istemci üretmek için de kullanabilirsiniz: openapi/v1.json.
Mekanlar
- GET
/venuesMekanları listeleAnahtarın okuyabildiği mekanlar, anahtarın kendi mekanı önce. - GET
/venues/{venueId}Mekanı okuMekanın adresi, konumu, saat dilimi, çalışma saatleri, menü dilleri ve şu an sipariş alıp almadığı. - GET
/venues/{venueId}/menuMenüyü okuMekanın kategorileri ve ürünleri: porsiyonları, fiyatları, ekstraları, seçim grupları, çıkarılabilir malzemeleri, alerjenleri ve stok durumuyla. - GET
/venues/{venueId}/tablesMasaları listeleMekanın katları, terasları ve salonları; her biri masalarıyla, kasada göründüğü sırayla.
Siparişler
- POST
/venues/{venueId}/orders/previewSepeti fiyatlaVereceğiniz siparişi göndermeden fiyatlayın: satırlar, kampanya indirimi, hizmet bedeli ve toplam. - POST
/venues/{venueId}/ordersSipariş verSiparişi doğrudan mekanın mutfağına gönderin. Onay adımı yoktur; mutfak fişi o an yazdırılır. - GET
/orders/{orderId}Siparişi okuBir siparişi mekanda şu an olduğu haliyle okuyun. - GET
/ordersSiparişleri listeleAPI üzerinden verilen siparişler, en yeni önce, sayfa sayfa.
Rezervasyonlar
- GET
/venues/{venueId}/reservation-availabilityMüsait saatleri listeleMekanın rezervasyon takvimi: istenen günler ve her birinde hala alınabilen saatler. - POST
/venues/{venueId}/reservationsRezervasyon alSitenizin aldığı rezervasyonu mekana gönderin. Mekanın rezervasyon listesine düşer; hemen onaylanıp onaylanmayacağı mekanın ayarına bağlıdır. - GET
/reservations/{reservationId}Rezervasyonu okuBir rezervasyonu mekanda şu an olduğu haliyle okuyun. - GET
/reservationsRezervasyonları listeleAPI üzerinden alınan rezervasyonlar, sayfa sayfa; açık olanlar en yakın saat önce. - POST
/reservations/{reservationId}/cancelRezervasyonu iptal etSitenizde fikrini değiştiren misafirin rezervasyonunu iptal edin. Misafirin iptalidir; mekana bildirilir.