İçeriğe geç

Mekanlar

Mekanı oku

Mekanın adresi, konumu, saat dilimi, çalışma saatleri, menü dilleri ve şu an sipariş alıp almadığı.

GET/public/v1/venues/{venueId}
Kimlik doğrulama

X-Api-Key başlığında API anahtarı

Gereken izin
Menüyü okuyabilir (her anahtarda var)
Hız sınırı
Anahtar başına dakikada yaklaşık 120 istek

ordering.acceptingOrdersNow her çağrıda yeniden hesaplanır. Mekanın aboneliği etkinse, yoğunluk bildirmemişse ve çalışma saatleri içindeyse (mekanın iki yana tanıdığı toleransla) true olur. false olduğunda ordering.busyUntil yoğunlukta dolu, kapalı mekanda null gelir.

Sitenizdeki sipariş düğmesini buna göre gösterip gizleyebilirsiniz; siparişi gönderdiğinizde durum yeniden kontrol edilir, çünkü iki çağrı arasında değişebilir. Ayrıntılar: Mekanlar ve şubeler.

Parametreler

venueIdstring · uuidYol parametresizorunlu

Mekan; GET /venues listesindeki kimliklerden biri.

Accept-LanguagestringBaşlık

Hata yanıtlarındaki userMessage metninin dili: tr (varsayılan), en, de, fr, it, es, ar ya da ru. Başlıktaki ilk dil belirler, bölgesi olmadan (en-US, en okunur) ve q ağırlıklarına bakılmadan; Cibusy'nin sunmadığı bir dil Türkçe yanıtlanır. Menünün dilini seçmez; o, menü çağrısındaki lang parametresidir.

Yanıtlar

200

Mekanın bilgileri.

401

X-Api-Key başlığı yok (PUBLIC_API_KEY_MISSING) ya da anahtar geçersiz veya iptal edilmiş (PUBLIC_API_KEY_INVALID).

403

Anahtar bu çağrıyı yapamaz (PUBLIC_API_SCOPE_MISSING). Panelde oluşturulan her anahtar mekanları, menüleri ve masaları okuyabilir.

404

Mekan yok ya da bu anahtar ona ulaşamıyor (PUBLIC_API_VENUE_NOT_FOUND).

429

Anahtarın dakikada yaklaşık 120 isteklik bütçesi doldu; Retry-After kadar saniye bekleyin.

Retry-After

Beklenecek saniye. Bir sonraki dakikalık pencere bu süre içinde açılır.

Başarılı yanıtın data alanı

Mekanın kendi sitesinin mekanı tanıtmak ve sipariş alıp almadığını bilmek için ihtiyaç duyduğu her şey: özetin yanında adres, çalışma saatleri, diller ve sipariş durumu.

idstring · uuid

Mekanın kimliği. Tek bir mekanla ilgili her çağrı bunu yolda alır.

namestring

Mekanın misafirlerin bildiği adı.

usernamestringnull olabilir

Mekanın Cibusy'deki sayfasının kullanıcı adı, menü bağlantısındaki ad (cibusy.com/modakofte). Mekan bir ad seçmediyse null.

typestring

Mekanın bağımsız mı, merkez mi, şube mi olduğu.

Independent
Bağımsız mekan: şubesi yok, bir merkeze bağlı değil.
Headquarter
Merkez: anahtarı aktif şubelerinin hepsine ulaşır.
Branch
Şube: anahtarı yalnız bu şubeye ulaşır, merkeze ya da diğer şubelere ulaşmaz.
parentVenueIdstring · uuidnull olabilir

Şubenin bağlı olduğu merkezin kimliği. Şube olmayan her mekanda null. Şube için oluşturulan bir anahtar merkezi okuyamaz; bu kimlik bir zincirin mekanlarını ayırt etmek içindir, bir çağrıda kullanmak için değil.

logoUrlstringnull olabilir

Mekanın logosunun adresi. Mekan logo yüklemediyse null.

addressobject

Mekanın adresi, yazıyla.

Adres alanları
linestringnull olabilir

Mekanın girdiği açık adres. Girmediyse null.

districtstringnull olabilir

İlçenin adı. Mekanın ilçesi artık kayıtlı değilse null.

citystringnull olabilir

İlin adı. Mekanın ili artık kayıtlı değilse null.

countrystringnull olabilir

Ülkenin adı. Mekanın ülkesi artık kayıtlı değilse null.

locationobjectnull olabilir

Mekanın haritadaki yeri. Mekan koordinat girmediyse null.

Konum alanları
latitudenumber

Enlem: ekvatorun kuzeyindeki derece, -90 ile 90 arası.

longitudenumber

Boylam: başlangıç meridyeninin doğusundaki derece, -180 ile 180 arası.

timeZonestring

Mekanın saat dilimi, IANA adıyla (Europe/Istanbul). Çalışma saatleri ile ordering.opensAt ve ordering.closesAt bu dilimdeki saatlerdir.

workingHoursobject[]

Mekanın girdiği çalışma saatleri, pazartesiden başlayarak. Girilmemiş bir gün listede yer almaz ve o gün mekan saate göre değerlendirilmez.

Çalışma saati alanları
daystring

Haftanın günü.

Değerler:SundayMondayTuesdayWednesdayThursdayFridaySaturday

opensAtstringnull olabilir

Mekanın açıldığı saat, mekanın saatiyle HH:mm. O gün kapalıysa null.

closesAtstringnull olabilir

Mekanın kapandığı saat, mekanın saatiyle HH:mm. Mekan gece yarısından sonra da açıksa opensAt değerinden küçüktür ve ertesi sabahı gösterir. O gün kapalıysa null.

isClosedboolean

Mekan o gün bütünüyle kapalıysa true.

orderingobject

Mekanın şu an sipariş alıp almayacağı ve bu cevabın dayandığı saatler. Her çağrıda yeniden hesaplanır.

Sipariş durumu alanları
acceptingOrdersNowboolean

Şu an verilen bir sipariş mekanın kurallarına göre kabul edilecekse true: aboneliği etkin, yoğunluk bildirmemiş ve çalışma saatleri içinde (mekanın iki yana tanıdığı toleransla; mekan bu kuralı kapatabilir, girilmemiş bir gün hiç değerlendirilmez). false olduğunda busyUntil yoğunluğu kapalı mekandan ayırır. Yine de siparişi göndererek tekrar kontrol edin: durum iki çağrı arasında değişebilir.

opensAtstringnull olabilir

Bugünün açılış saati, mekanın saatiyle HH:mm; mekan saatlerine uyuyor ve bugün için saat girmişse. Aksi halde null; mekan yoğunken de her zaman null.

closesAtstringnull olabilir

Bugünün kapanış saati, mekanın saatiyle HH:mm. Mekan gece yarısından sonra da açıksa opensAt değerinden küçüktür. opensAt ile aynı koşullarda null.

busyUntilstring · date-timenull olabilir

Mekanın bildirdiği yoğunluğun bittiği an (UTC). Doluysa mekan açıktır ama mutfağı o ana kadar sipariş almıyordur; sayfanız "kapalı" demek yerine geri sayım gösterebilir. Yoğunluk yoksa null.

busyReasonstringnull olabilir

Mekanın yoğunluk için misafirlerine yazdığı cümle. Yoğunluk yoksa ya da mekan bir sebep yazmadıysa null.

languagesobject[]

Menünün sunulduğu diller, varsayılan dil önce. Menü uç noktası bunların kodlarından birini lang olarak kabul eder. Hiç dil ayarlamamış mekanda boştur; menü o zaman yalnız mekanın yazdığı haliyle gelir.

Dil alanları
codestring

Dilin iki harfli ISO 639-1 kodu; menü uç noktasının lang parametresinin aldığı değer.

namestring

Dilin adı, bir dil seçici için.

isDefaultboolean

lang istenmediğinde menünün geldiği dil için true.

currencystring

Tüm fiyatların para birimi, ISO 4217 kodu. Her zaman TRY; fiyatlar KDV dahildir.