Çalışma Alanı
Webhook'lar
Webhook uç noktaları ekleyin, olayları seçin, imzalı teslimatları doğrulayın ve teslimat günlüğünü izleyin.
Markdown olarak görüntüleAyarlar içindeki Webhook'lar bölümü (/settings/webhooks), mağazanızda bir şey olduğunda Borkol'un bilgilendireceği uç noktaları yönetir. Webhook'lar, sipariş, stok ve içerik olaylarını gerçekleştikleri anda storefront'unuza veya entegrasyonunuza gönderir; böylece API'yi yoklamanız gerekmez. Borkol, abone olduğu olaylar için her uç noktaya imzalı JSON POST eder.
Bu sayfa panel tarafını anlatır; payload formatları, imza ayrıntıları ve yeniden deneme davranışı Webhooks API referansında yer alır.
Uç nokta ekleyin
- Ayarlar sayfasını açın ve Webhook'lar bölümünü seçin.
- Uç nokta ekle kutusunda, sunucunuzun dinlediği Uç nokta URL'si değerini girin (örneğin
https://example.com/webhooks/borkol). - En az bir olay işaretleyin. Hem bir URL hem de bir olay belirleyene kadar Oluştur düğmesi devre dışı kalır; yanındaki ipucu hangisinin eksik olduğunu söyler.
- Oluştur düğmesine tıklayın.
Olaylar
Seçebileceğiniz dokuz olay vardır:
| Olay | Ne zaman gönderilir |
|---|---|
order.created | Yeni bir sipariş verildiğinde. |
order.status_changed | Bir sipariş farklı bir duruma geçtiğinde. |
stock.adjusted | Bir stok seviyesi değiştiğinde. |
object_record.published | Yayınlama açık olan bir türün taslak kaydı yayınlandığında (daha sonrası için zamanlanmış olsa bile). |
object_record.updated | Yayınlanmış bir kaydın değerleri, adresleri veya Yayın tarihi değiştiğinde. |
object_record.unpublished | Yayınlanmış bir kayıt Taslak durumuna geri alındığında. |
object_record.deleted | Yayınlanmış bir kayıt silindiğinde. |
form.published | Bir formun yeni bir sürümü yayınlandığında. |
form_submission.created | Bir ziyaretçi formlarınızdan birini gönderdiğinde. |
İmzalama sırrını kopyalayın: yalnızca bir kez gösterilir
Uç nokta oluşturulduktan hemen sonra, uç noktanın imzalama sırrı Bu imzalama sırrını şimdi kopyalayın. Yalnızca bir kez gösterilir. başlıklı bir kutuda görünür. Sırrı hemen sunucunuzda saklayın:
- Sunucunuz her teslimatı,
X-Borkol-Signaturebaşlığını ham istek gövdesinin bu sırla hesaplanmış HMAC-SHA256 değeriyle karşılaştırarak doğrular. Eşleşmeyen teslimatları reddedin. - Sayfadan ayrıldıktan sonra sır bir daha asla görüntülenemez. Kaybederseniz, yeni bir sır almak için uç noktayı silin ve yeniden ekleyin.
Bir uç noktayı açın veya kapatın
Her uç nokta satırında bir Etkin / Etkin değil anahtarı vardır. Uç noktayı silmeden teslimatları duraklatmak için anahtarı kapatın, devam ettirmek için yeniden açın. Anahtar anında güncellenir; kaydetme başarısız olursa eski konumuna döner ve bir hata gösterir.
Test ping'i gönderin
Bir uç noktaya ping teslimatı göndermek için Test düğmesine tıklayın. Onay olarak Ping gönderildi. mesajını görürsünüz. Gerçek olaylar akmaya başlamadan önce sunucunuzun teslimatları alıp doğruladığını kontrol etmek için bunu kullanın.
Teslimat günlüğünü kontrol edin
Bir uç noktanın teslimat günlüğünü satır içinde genişletmek için Teslimatlar düğmesine tıklayın (daraltmak için Teslimatları gizle düğmesine tıklayın). Her satırda şunlar görünür:
| Sütun | Açıklama |
|---|---|
| Durum | Teslimat durumu rozeti (aşağıya bakın). |
| Olay | Teslim edilen olay. |
| Yanıt | Sunucunuzun döndürdüğü HTTP durumu; yanıt yoksa tire. |
| Denemeler | Kaç teslimat denemesi yapıldığı. |
| Tarih | Teslimatın gerçekleştiği tarih ve saat. |
| Durum | Anlamı |
|---|---|
pending | Kuyrukta veya hâlâ yeniden deneniyor. |
success | Sunucunuz teslimatı kabul etti. |
failed | Teslimat, tüm denemeler tükendikten sonra vazgeçti. |
Hiç teslimat almamış bir uç nokta Henüz teslimat yok. mesajını gösterir.
Bir uç noktayı silin
- Uç noktanın satırındaki Sil düğmesine tıklayın.
- Bir Uç noktayı sil iletişim kutusu onay ister: uç nokta, olayları hemen almayı durdurur.
- Onaylamak için Sil düğmesine tıklayın.
Silme işlemi uç noktanın imzalama sırrını da yok eder. Yalnızca teslimatları duraklatmak istiyorsanız bunun yerine Etkin anahtarını kullanın.