Temeller
Başlarken
Bir API anahtarı oluşturun, ilk isteğinizi gönderin ve mekanınızı, menünüzü ve masalarınızı birkaç dakikada okuyun.
Cibusy API, mekanınızın kendi web sitesinin, uygulamasının ya da yazılımının Cibusy hesabınızla birlikte çalışmasını sağlar. Mekanınızı, menünüzü ve masalarınızı okur; bir sepetin tutarını hesaplar; siparişi doğrudan mutfağınıza gönderir ve mekan hesabı kapatana kadar takip eder.
Bu rehberde bir API anahtarı oluşturacak, ilk isteğinizi gönderecek ve menünüzü okuyacaksınız. Buradaki isteklerin hiçbiri sipariş vermez.
Uyarı: Cibusy API'nin ayrı bir test ortamı yoktur. Gerçek bir anahtarla verilen sipariş, mekanınızda gerçek bir sipariştir ve mutfakta fişi basılır. Siparişle ilgili denemelerinizi önce sepeti fiyatlandırarak yapın.
Başlamadan önce#
- Bir Cibusy mekan hesabı. Anahtarları mekanın sahibi, panele mekan hesabıyla girerek oluşturur; çalışan hesapları anahtar oluşturamaz.
- Etkin bir abonelik, sipariş ve rezervasyon için. Menüyü ve masaları okumak için gerekmez; aboneliği sona ermiş bir mekanın anahtarı da okumaya devam eder.
- Bir HTTP istemcisi. Bu rehberdeki örnekler
curlile yazıldı; API referansında her isteğin Node.js, PHP, Python ve C# karşılığı da var.
1. Bir API anahtarı oluşturun#
- Cibusy panelinde mekan hesabınızla oturum açın ve API Anahtarları sayfasını açın.
- Yeni Anahtar düğmesine basın ve anahtara, onu kullanacak site ya da yazılımın adını verin: "Web sitesi" gibi. Bu ad, anahtarla gelen siparişlerde de görünür.
- Bu rehber için Menüyü okuyabilir izni yeterli; bu izin her anahtarda açıktır. Sipariş göndermeye ya da rezervasyon almaya hazır olduğunuzda Sipariş gönderebilir ya da Rezervasyon alabilir iznini de açarsınız.
- Anahtar Oluştur düğmesine basın ve gösterilen anahtarı kopyalayın.
Anahtar cbk_ ile başlar ve yalnız bir kez gösterilir. Cibusy anahtarın kendisini saklamaz; kaybederseniz anahtarı iptal edip yenisini oluşturursunuz.
Anahtar, mekanınızın kimlik bilgisidir. Onu sunucunuzun yapılandırmasında tutun; bir web sayfasına, mobil uygulamaya ya da kod deposuna koymayın. Nedenini Kimlik doğrulama rehberi anlatıyor.
2. İlk isteği gönderin#
Anahtarı bir ortam değişkenine koyun ve anahtarın ulaştığı mekanları listeleyin:
export CIBUSY_API_KEY="cbk_..."
curl https://api.cibusy.com/public/v1/venues \
-H "X-Api-Key: $CIBUSY_API_KEY"Liste, anahtarın oluşturulduğu mekanla başlar. Bir merkezin anahtarı, merkezin aktif şubelerini de listeler:
{
"success": true,
"timestamp": "2026-10-01T09:30:00.123Z",
"traceId": null,
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Moda Köfte",
"username": "modakofte",
"type": "Headquarter",
"parentVenueId": null
},
{
"id": "9b2d4f61-8c3a-4e75-a1d0-6f4b2c8e9d13",
"name": "Moda Köfte Bostancı",
"username": "modakoftebostanci",
"type": "Branch",
"parentVenueId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"message": "Operation completed successfully"
}Her başarılı yanıt bu zarfla gelir ve sonuç data alanındadır. Bir mekanla ilgili bütün çağrılar, o mekanın id değerini adresin içinde alır.
401 yanıtı aldıysanız X-Api-Key başlığı eksiktir ya da anahtar tanınmıyordur: anahtarın tamamını kopyaladığınızdan ve iptal edilmediğinden emin olun.
3. Menünüzü okuyun#
Mekanın kimliğiyle menüyü isteyin. lang, menünün hangi dilde geleceğini söyler:
curl "https://api.cibusy.com/public/v1/venues/3fa85f64-5717-4562-b3fc-2c963f66afa6/menu?lang=tr" \
-H "X-Api-Key: $CIBUSY_API_KEY"Yanıtta kategoriler ve içlerindeki ürünler gelir: her ürünün porsiyonları ve KDV dahil fiyatları, ekstraları, seçim grupları, çıkarılabilir malzemeleri, alerjenleri ve stok durumu. Menüde yalnız mekanın misafirlerine gösterdikleri yer alır.
Menüyü sitenizin her ziyaretçisi için yeniden istemeyin. Bir kopyasını sunucunuzda tutup nasıl güncel tutacağınızı Menüyü okumak rehberi anlatıyor.
4. Siparişe hazırlanın#
Sipariş göndermek için anahtarın Sipariş gönderebilir izni olmalı. İzni paneldeki Düzenle ile açabilirsiniz; değişiklik anahtarın bir sonraki isteğinde geçerli olur.
Bir sepeti sipariş vermeden fiyatlandırmak için POST /venues/{venueId}/orders/preview çağrısını kullanın. Siparişle aynı gövdeyi alır ve sepeti bir sipariş gibi kontrol eder; toplamı söyler ama mutfağa hiçbir şey göndermez.
curl -X POST "https://api.cibusy.com/public/v1/venues/3fa85f64-5717-4562-b3fc-2c963f66afa6/orders/preview" \
-H "X-Api-Key: $CIBUSY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "DineIn",
"tableId": "2f4e6a8c-0b1d-4c3e-9f5a-7b9d1e3c5a70",
"note": "Bir misafirin fıstık alerjisi var.",
"lines": [
{
"productId": "5d2c8a41-7b0e-4c36-8f1d-9e4a6b3c2d10",
"portionId": "a8e1f6c3-2d94-4b70-b5a6-1c7d9e0f3a24",
"quantity": 2,
"note": "Köfteler ayrı paketlensin.",
"extraIds": [
"f1a2b3c4-d5e6-4f70-8192-a3b4c5d6e7f8",
"b4c5d6e7-f8a9-4b1a-8c2d-3e4f5a6b7c8d"
],
"removedIngredientIds": [
"b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e"
]
}
]
}'Fiyatı her zaman sunucu hesaplar: istekte fiyat yoktur. Yanıttaki total, aynı sepetin sipariş edildiğinde tutacağı tutardır.
Sonraki adımlar#
- Kimlik doğrulama: anahtarın izinleri, anahtarı yenilemek ve iptal etmek.
- Sipariş vermek: sipariş türleri, isteği güvenle yeniden denemek ve siparişi takip etmek.
- Rezervasyon almak: mekanın müsait saatleri, rezervasyonu göndermek, misafire haber vermek ve iptal.
- Webhook'lar: bir sipariş ya da rezervasyon değiştikçe sunucunuza gelen imzalı bildirimler.
- Hatalar ve Hız sınırları: canlıya çıkmadan önce okumanız gerekenler.
- API referansı: her uç noktanın parametreleri, alanları ve örnekleri.