Webhooks

Webhooks, API görevleriniz tamamlandığında veya durum değiştirdiğinde Meshy'den gerçek zamanlı güncellemeler almanızı sağlar. Yapılandırıldıktan sonra, Meshy belirttiğiniz URL'lere json formatında olay yükleri POST edecektir.

Webhooks Oluşturmanın Nedenleri

Webhooks kullanmanın, özellikle API görev durumlarını otomatik olarak kontrol etme konusunda birçok avantajı vardır. Webhooks, görev durumu güncellemelerini almak için API'yi sürekli olarak sorgulamaktan daha az çaba ve maliyet gerektirir. Webhooks ayrıca neredeyse gerçek zamanlı güncellemeler sağlar ve API sorgulamasından daha iyi ölçeklenir. Bu, özellikle sürekli sorgulama yapıyorsanız, hız sınırlarınızı daha iyi yönetmenizi sağlar.

Kurulum ve Yapılandırma

Webhooks'u etkinleştirmek için, Meshy web uygulamasına giriş yaptığınızda API ayarları sayfasına gidin. API Anahtarlarınızın altındaki "Webhooks" bölümünü bulun ve "Webhook Oluştur" düğmesine tıklayın. Webhooks almak istediğiniz https URL'sini sağlayın ve Meshy'den görev güncellemelerini otomatik olarak almak için webhook'u etkinleştirin. Her Meshy hesabı başına maksimum 5 aktif webhook'a sahip olabilirsiniz. Bir webhook etkinleştirildiğinde, tüm API görev durumu güncellemeleri otomatik olarak yük URL'sine gönderilecektir. Güvenlik amacıyla, şu anda yalnızca https URL'lerine webhook gönderilmesine izin veriyoruz. Yerel test yapılandırmak istiyorsanız, aşağıdaki bölüme bakın.

Webhook Teslimat Gereksinimleri

Webhook'unuzun normal çalışması ve olayları almaya devam etmesi için:

  • Sunucunuzun 400'ün altında bir HTTP durum kodu ile yanıt vermesi gerekir (örneğin, 200 OK, 202 Accepted).
  • >= 400 durum koduna sahip herhangi bir yanıt başarısız teslimat olarak kabul edilecektir.
  • Birden fazla ardışık başarısızlık:
    • İlerleme güncellemelerinin gecikmesine veya sırasız gelmesine neden olabilir
    • Tekrarlanan denemelerden sonra webhook'unuzu otomatik olarak devre dışı bırakabilir (bkz. Otomatik Devre Dışı Bırakma Politikası)

İpucu: Webhook yükünü doğrulayıp depoladıktan sonra, daha fazla işlem asenkron olarak yapılsa bile her zaman bir başarı yanıtı döndürün.

Yerel Test İçin Webhook Yönlendirme

Webhook kodunuzu yerel olarak test etmek istiyorsanız, genellikle bir http adresinde olan, bir webhook proxy URL'si kullanarak webhooks'u bilgisayarınıza veya kod alanınıza yönlendirebilirsiniz. Aşağıda smee.io kullanarak önerilen adımlar verilmiştir, ancak istediğiniz herhangi bir hizmeti kullanarak bir webhook proxy URL'si oluşturabilirsiniz.

Bir webhook proxy URL'si alın:

  1. Tarayıcınızda https://smee.io/ adresine gidin
  2. "Yeni bir kanal başlat" seçeneğine tıklayın
  3. "Webhook Proxy URL" altında tam URL'yi kopyalayın. Bu URL'yi aşağıdaki kurulum adımlarında kullanacaksınız.

Webhooks'u yönlendirin:

  1. Henüz smee-client yüklü değilse, terminalinizde aşağıdaki komutu çalıştırın.
npm install --global smee-client
  1. smee.io'dan yönlendirilen webhooks'u almak için terminalinizde aşağıdaki komutu çalıştırın. WEBHOOK_PROXY_URL'yi daha önce aldığınız webhook proxy URL'si ile değiştirin.
smee --url WEBHOOK_PROXY_URL --path /webhook --port 3000

Aşağıdaki gibi bir çıktı görmelisiniz, burada WEBHOOK_PROXY_URL sizin webhook proxy URL'nizdir:

Forwarding WEBHOOK_PROXY_URL to http://127.0.0.1:3000/webhook
Connected WEBHOOK_PROXY_URL
  1. Webhook'unuzu test ederken bu işlemi çalışır durumda tutun. Webhooks'u yönlendirmeyi durdurmak istediğinizde Ctrl+C tuşlarına basın.
    Unutmayın ki yol /webhook ve port 3000'dir. Bu değerler, daha sonra kendi kodunuzu webhook teslimatlarını almak için ayarlamak istediğinizde işinize yarayabilir.

Bir webhook oluşturun:

Artık Meshy API ayarları sayfasında yeni bir webhook oluşturmak için webhook proxy URL'sini kullanabilirsiniz.

Örnek Yanıt

Bir görev durumu değiştiğinde, Meshy yapılandırılmış URL'nize bir webhook yükü POST edecektir. Yük, JSON formatında görev nesnesini içerir. Tüm görev nesnesi özelliklerinin ve örnek yüklerin tam açıklaması için bkz: