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

Webhook'lar

Test olayı gönder

Anahtarın webhook adresine gerçek bir olay gibi imzalanmış bir webhook.test olayı gönderin ve sunucunuzun ne yanıt verdiğini görün.

POST/public/v1/webhooks/test
Kimlik doğrulama

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

Gereken izin
Sipariş gönderebilir ya da Rezervasyon alabilir
Hız sınırı
Anahtar başına dakikada yaklaşık 30 istek

Çağıran anahtarda tanımlı adrese, anahtarın sırrıyla gerçek bir olay gibi imzalanmış tek bir webhook.test olayı gönderir ve nasıl gittiğini söyler. Bir sipariş ya da rezervasyon onlara bağlı olmadan önce adresi, sertifikayı ve imza kontrolünüzü denemek için kullanın. Anahtarın Sipariş gönderebilir ya da Rezervasyon alabilir izinlerinden biri olması yeterlidir.

Çağrı sunucunuzun yanıtını en fazla 10 saniye bekler. Hiçbir sipariş ya da rezervasyon değişmez ve test olayı yeniden denenmez. Sunucunuz olayı kabul etse de etmese de yanıt 200 olur; delivered hangisi olduğunu söyler.

Olayın gövdesi, başlıkları ve imzanın nasıl doğrulanacağı Webhook'lar rehberinde.

Rehber: Webhook'lar

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

Test olayı gönderildi. delivered alanına bakın: sunucunuz 2xx dışında bir durumla yanıt verdiyse ya da ulaşılamadıysa false olur ve nedenini error söyler.

401

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

403

PUBLIC_API_SCOPE_MISSING: anahtar ne "Sipariş gönderebilir" ne de "Rezervasyon alabilir" izniyle oluşturulmuş.

409

PUBLIC_API_WEBHOOK_NOT_CONFIGURED: bu anahtarda webhook adresi yok. Paneldeki API anahtarları sayfasından ekleyin.

429

Anahtarın siparişler, rezervasyonlar ve testler için dakikada yaklaşık 30 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ı

POST /webhooks/test ile gönderilen test olayının sonucu.

deliveredboolean

Uç noktanızın olayı kabul edip etmediği: izin verilen süre içinde 2xx bir durumla yanıt verdiyse true. false olduğunda nedenini statusCode ya da error söyler.

statusCodeintegernull olabilir

Uç noktanızın döndüğü HTTP durumu. Hiç yanıt vermediyse (ulaşılamadı ya da çok yavaştı) null.

errorstringnull olabilir

Gönderimin neden başarısız olduğu, bir geliştirici için kısa bir cümleyle. Teslim edildiyse null. İmza sırrını, imzayı ya da adresin sorgu kısmını hiçbir zaman içermez.

durationMsinteger

Denemenin kaç milisaniye sürdüğü.