İçeriğe geç
CibusyGeliştiriciler
TREN
API anahtarı al

Mekanlar

Mekanları listele

Anahtarın okuyabildiği mekanlar, anahtarın kendi mekanı önce.

GET/public/v1/venues
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

Anahtarın kendi mekanı her zaman ilk sıradadır. Bir merkez için oluşturulan anahtarda merkezin şubeleri adlarına göre ardından gelir; bir şube için oluşturulan anahtar yalnız o şubeyi listeler.

Tek bir mekanla ilgili her çağrı, mekanın buradaki id değerini yolda alır. Ayrıntılar: Mekanlar ve şubeler.

Rehber: Mekanlar ve şubeler

Parametreler

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

Anahtarın okuyabildiği mekanlar, kendi mekanı önce.

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.

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ı: bu nesnelerin dizisi

Anahtarın okuyabildiği bir mekan, mekan listesinin kısa biçimiyle.

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.