Webhook Genel Kullanım
T-Soft WebHook Genel Kullanım Rehberi
WebHook, modern web geliştirmede sıkça kullanılan ve tetiklemeye ihtiyaç duymayan bir mekanizmadır. Bir uygulama içinde gerçekleşen belirli olayların (event) başka bir uygulamaya anında iletilmesini sağlar. Klasik API çağrılarından farklı olarak sürekli sorgulama yapmayı gerektirmez; ilgili olay meydana geldiğinde otomatik olarak tetiklenir ve belirlenen URL'e veri iletilir.
Ücret Tarifesi ve Koşullar
WebHook lisansı ek bir satın alma gerektirmez ancak aktif edilmesi gerekir. Lisans ücreti aylık en az 10 USD + KDV olarak faturalandırılır. T-Soft siteleri arasında yapılan entegrasyonlar "Site İçi", farklı adreslerle yapılanlar ise "Site Dışı" olarak kabul edilir.
| Kategori | 3 Sn WebHook | 5 Sn WebHook | 7 Sn WebHook |
|---|---|---|---|
| Site İçi | 0,001 USD | 0,002 USD | 0,003 USD |
| Site Dışı | 0,002 USD | 0,003 USD | 0,004 USD |
*Birim fiyatlar USD + KDV cinsindendir.
İşlem ve Kurulum Adımları
WebHook yapılandırmasını başlatmak için yönetim panelinizde şu adımları takip edin:
- Ayarlar > Kontrol Merkezi (veya İş Akışları) sayfasına tıklayın.
- Webhook sekmesine tıklayın.
- Yeni webhook eklemek için artı (+) butonuna tıklayın.
Teknik Parametrelerin Tanımı
- Yük Adresi (Payload URL):
WebHook POST isteklerinin iletileceği sunucu adresidir. Bu adresin internette erişilebilir, aktif bir URL olması gerekir. Geçersiz bir URL girildiğinde olay bildirimi gönderilmez. URL geçerli olsa da bir HTTP hatası döndürüyorsa, bildirim otomatik olarak yeniden gönderilmek üzere sıraya alınır.
İçerik Türü (Content Type):
WebHook’lar, olay bildirimlerini farklı içerik türleriyle iletebilir. Listeden size uygun olan içerik tipini seçerek gelen veriyi istediğiniz formatta işleyebilirsiniz.
Desteklenen içerik türleri: application/json ve application/x-www-form-urlencoded
- Gizli Anahtar (Secret Key):
WebHook isteğinin gerçekten T-Soft sisteminden geldiğini doğrulamak için bir güvenlik anahtarı kullanabilirsiniz. Bu anahtar, istek sırasında header içinde X-Hub-Signature başlığıyla gönderilir. Bu başlığı kontrol ederek, isteğin doğruluğunu ve URL’nizin güvenliğini sağlayabilirsiniz. “Oluştur” butonuna tıklayarak gizli anahtarı oluşturabilirsiniz.
- Zaman Aşımı (Timeout):
Zaman aşımı, WebHook isteğinin yanıt bekleme süresini belirlediğiniz alandır. Bu süre, web kancası üzerinden gerçekleştirilen işlemlerin maksimum çalışma süresini ifade eder. Belirlenen süre sonunda işlem tamamlanmazsa istek sonlandırılır. Seçtiğiniz süreye göre, event’ler içerisindeki veriler bu zaman diliminde çekilip işlenecektir.
- Olaylar (Events):
Oluşturduğunuz WebHook ile veri aktarımı yapılacak işlemleri bu alandan seçebilirsiniz.
NOT: Sipariş öncesi olayları ile ilgili işlemler, ek WebHook lisansı gerektirir. Bu özelliği kullanmak için destek ekibimizle iletişime geçerek ilgili lisansın aktif edilmesini talep edebilirsiniz.
İstek (Request) : WebHook’a gönderilen isteğin detaylarını görüntüleyebileceğiniz sekmedir. Bu alanda HTTP metodu, URL, header bilgileri ve içerik tipleri gibi gönderilen tüm teknik detaylar yer alır.
Yanıt (Response) : WebHook isteğine sunucudan dönen yanıtın detaylarını görüntüleyebileceğiniz sekmedir. HTTP durum kodu, yanıt içeriği ve varsa hata mesajları bu bölümde listelenir. Bu sekme, isteğin başarılı olup olmadığını ve sunucunun yanıt süresini kontrol etmek için kullanılır.
Yük (Payload) : WebHook ile gönderilen verinin kendisini görüntüleyebileceğiniz sekmedir. JSON veya form-data formatındaki asıl veri, bu sekmede açık bir şekilde listelenir ve hangi bilgilerin gönderildiğini detaylı olarak inceleyebilirsiniz.
WEBHOOK TEST İŞLEMİ SAĞLAMA
Entegrasyon Test İşlemi Sağlama
Site ve demolarınızda sanal ortamda testler gerçekleştirmek için webhook.site adresini kullanabilirsiniz:
- Siteden aldığınız “Your Unique URL” bilgisini kopyalayıp “Yük Adresi” alanına ekleyin.
- “Test” ve ardından “Kaydet” butonuna tıklayarak işlemi tamamlayın.
- “Ping” butonuna tıklayarak webhook.site üzerinden gelen isteği JSON formatında anlık inceleyin.
WebHook özelliği sayesinde site ve demolarınızda sanal ortamda entegrasyon testleri gerçekleştirebilir, WebHook olay tiplerinin içeriklerini JSON formatında görüntüleyebilirsiniz. Test işlemleri için WebHook.site adresini kullanabilirsiniz. Siteye ilk girişte test amaçlı benzersiz bir “Your Unique URL” oluşturulur. Bu URL’yi kopyalayarak test süreçlerinizde kullanabilirsiniz.
WebHook özelliği sayesinde site ve demolarınızda sanal ortamda entegrasyon testleri gerçekleştirebilir, WebHook olay tiplerinin içeriklerini JSON formatında görüntüleyebilirsiniz. Test işlemleri için webhook.site adresini kullanabilirsiniz. Siteye ilk girişte test amaçlı benzersiz bir “Your Unique URL” oluşturulur. Bu URL’yi kopyalayarak test süreçlerinizde kullanabilirsiniz.
Oluşturulan benzersiz “Your Unique URL” bilgisini, oluşturduğunuz WebHook detayında yer alan “Yük Adresi” alanına ekleyin. Ardından “Test” butonuna, sonrasında “Kaydet” butonuna tıklayarak işlemi tamamlayın. WebHook detayındaki diğer alanları ise, önceki slaytlarda yer alan içeriklere göre düzenleyebilirsiniz.
WebHook üzerinden gelen istekleri webhook.site sayfasında görüntüleyebilirsiniz. Seçtiğiniz olaylara bağlı olarak gönderilen istekler, belirlenen zaman aşımı süresine göre siteye iletilecektir.
Gelen isteklerin üzerine tıkladığınızda, ilgili isteğin içeriğini detaylı olarak görüntüleyebilirsiniz.
İzleme ve Hata Ayıklama (Geçmiş)
WebHook’un çalışma durumunu “Ping” butonu ile kontrol edebilir, tüm aktarım loglarını “Geçmiş” alanından inceleyebilirsiniz:
- HTTP Kodu: Başarı durumunu takip edin (Örn: 200 başarılı, 500 başarısız).
- İstek (Request) & Yanıt (Response): Header bilgileri, sunucu yanıt içeriği ve hata mesajlarını detaylı olarak listeler.
- Yük (Payload): Gönderilen asıl veriyi (JSON veya form-data) açık bir şekilde görüntüler.
- Kayıtları Göster: WebHook üzerindeki düzenleme ve silme işlemlerine ait kullanıcı loglarını inceleyebilirsiniz.
T-Soft WebHook ile gerçek zamanlı veri yönetiminin keyfini çıkarın!
