Sürümler ve destek

Cibusy API'nin bu sürümü v1'dir ve her yolu /public/v1 ile başlar. Bu rehber v1 içinde neyin hiç değişmeyeceğini, nelerin eklenebileceğini ve entegrasyonunuz için nasıl yardım alacağınızı anlatıyor.

v1'de değişmeyenler#

v1 içinde hiçbir şey kaldırılmaz ve hiçbir şey yeniden adlandırılmaz. Kullandığınız bir alan, bir değer ya da bir durum kodu olduğu gibi kalır.

Bu sözü bozacak bir değişiklik v1 içinde yapılmaz; yeni bir sürüm olarak, /public/v2 altında, v1'in yanında yayımlanır.

Eklenebilenler#

v1 içinde yalnız ekleme yapılır:

• Bir yanıta yeni alanlar eklenebilir.
• Bir sabit değer listesine, örneğin bir sipariş durumuna, sipariş türüne ya da bir birime yeni değerler eklenebilir.
• Yeni uç noktalar eklenebilir.

Kodunuzu buna göre yazın: tanımadığınız alanları yok sayın, tanımadığınız bir değeri de sisteminizi bozmayacak şekilde karşılayın. Örneğin bir sipariş durumunu ekranda gösterirken bilinmeyen bir değer için genel bir ifadeye düşün:

const STATUS_LABELS = {
  Received: 'Sipariş alındı',
  Preparing: 'Hazırlanıyor',
  Ready: 'Hazır',
  Served: 'Servis edildi',
  OnTheWay: 'Yolda',
  Completed: 'Tamamlandı',
  Cancelled: 'İptal edildi',
};

function statusLabel(status) {
  // v1'e sonradan eklenen bir değer de anlamlı bir etiket alır.
  return STATUS_LABELS[status] ?? 'Sipariş güncellendi';
}

Yanıtları katı bir şemayla doğruluyorsanız fazladan alanlara izin verin; böylece yeni bir alan eklendiğinde kodunuz hata vermez.

OpenAPI belgesi#

API'nin bütün uç noktalarını ve alanlarını tanımlayan OpenAPI 3 belgesi şu adreste:

https://api.cibusy.com/developers/openapi/v1.json

Belgeyi kullandığınız dil için bir istemci ya da tip tanımları üretmek için kullanabilirsiniz. Webhook olaylarının gövdeleri de belgede OrderUpdatedWebhookEvent, ReservationUpdatedWebhookEvent ve TestWebhookEvent şemaları olarak yer alır. Bu portaldaki API referansı aynı belgeden beslenir.

Destek#

Entegrasyonunuzla ilgili yardım için support@cibusy.com adresine mekanın kendi e-posta adresinden yazın ve hangi mekan olduğunu belirtin. Yazarken şunları ekleyin:

• Hata yanıtında varsa traceId değeri: isteği kayıtlarımızda bulmamızı sağlar.
• Sözünü ettiğiniz siparişin id değeri.
• İsteğin ne zaman yapıldığı, hangi uç noktaya gittiği ve aldığınız errorCode.

API anahtarınızı ya da webhook sırrınızı e-postaya hiçbir zaman yazmayın: isteği bulmamız için traceId ile sipariş ya da rezervasyon kimliği yeterlidir.