Sanity'yi Shopify Flow'a nasıl bağlayabilirim?

Sanity'yi Shopify Flow'a nasıl bağlayabilirim?

Sayfayı kopyala

Sanity webhook'larını HMAC doğrulamasıyla Shopify Flow tetikleyicisine dönüştürün; içerik yayınlandığında meta alan güncelleyin veya e-posta gönderin.

Sanity, sorgunuzla eşleşen içerik oluşturulduğunda, güncellendiğinde veya silindiğinde GROQ destekli bir webhook gönderir. Workflow Webhooks, bu çağrıyı bir Shopify Flow tetikleyicisine dönüştürür; böylece mağazanız buna tepki verebilir: bir müşteriye etiket ekleyebilir, sipariş notu ekleyebilir, dahili bir e-posta gönderebilir, bir meta alanı güncelleyebilir - kısacası Shopify Flow’un yapabileceği her şeyi gerçekleştirebilir.

Bu kılavuz, tüm süreci ortaya koymaktadır - Sanity gönderir, Workflow Webhooks alır ve doğrular, Shopify Flow harekete geçer - her istekte Sanity’nin HMAC imzası kontrol edildiğinden, iş akışınızı yalnızca Sanity başlatabilir.

Neler yapabileceğiniz

  • Eşleşen CMS girdisi değiştiğinde Shopify meta alanını güncelleyin; böylece mağaza sayfası da buna ayak uydursun.
  • Bir açılış sayfası yayınlandığında, pazarlama ekibinize e-posta gönderin.
  • İçerik yayınlandıktan sonra önbellek yenileme iş akışını başlatın.

Gönderilebilecek tipik olaylar: bir belgenin yayınlanması, bir belgenin güncellenmesi, bir belgenin silinmesi.

Başlamadan önce

  • Shopify mağazanıza yüklenmiş Workflow Webhooks.
  • Shopify Flow, Shopify Uygulama Mağazasından ücretsiz olarak indirilip kuruldu.
  • Webhook oluşturma iznine sahip bir Sanity hesabı.

1. Adım - Workflow Webhooks'ta webhook'u oluşturun

  1. Workflow Webhooks'u açın -> Webhooks -> Webhook oluştur seçeneğine tıklayın ve Shopify Flow'da kolayca tanıyabileceğiniz bir ad verin; örneğin Sanity events gibi.
  2. Kimlik Doğrulama bölümünden HMAC'yi seçin.
  3. İmza sağlayıcısı bölümünden Sanity’yi seçin. Uygulama, başlığı, algoritmayı, imzalanmış veri yükünü ve tekrar oynatma aralığını sizin için otomatik olarak doldurur; ayarlanacak başka bir şey yoktur.
  4. Şimdilik gizli alanı boş bırakın ve Kaydet'e tıklayın. Sayfada gösterilen webhook URL'sini kopyalayın.

Diğer kimlik doğrulama modları için Kimlik Doğrulama’a, hangi alanların Shopify Flow’a aktarılacağını seçmek için ise Yük haritalama ve Shopify Flow değişkenleri’a bakın.

2. Adım - Sanity'ye uç noktayı ekleyin

Sanity'de API → Webhooks bölümünü açın, kopyaladığınız URL ile GROQ destekli bir webhook oluşturun ve Gizli Anahtarı ayarlayın.

Sanity imza gizli anahtarınızı nasıl bulabilirsiniz?

GROQ tarafından desteklenen webhook’ta “The Secret” ayarı.

Sanity'nin webhook imzalarıyla ilgili kendi belgeleri, hesabınız için tam metni ve ekran görüntülerini içeriyor.

Bu gizli anahtarı, Workflow Webhooks'taki webhook'un Secret alanına yapıştırın ve kaydedin. O andan itibaren her Sanity teslimatı, Shopify Flow'a ulaşmadan önce doğrulanır.

Bu kontrolün amacı

Ne Değer
İmza başlığı sanity-webhook-signature
İmzanın bulunduğu yer Virgülle ayrılmış key=value çiftlerini içeren bu başlığın v1 değerinde
Neyin imzalandığı {timestamp}.{body}
İmza HMAC-SHA256, base64url kodlamalı
Zaman damgası İmza başlığındaki t değeri, Unix milisaniye cinsinden
Tekrar oynatma koruması Yok - bu gönderen zaman damgasını imzalamamaktadır; dolayısıyla tüm geçerli imzalar geçerliliğini korur
Sır Düz metin olarak kullanılır. Göndericinin gösterdiği şekilde aynen yapıştırın.

İmzalı yükte, {body}, bayt bayt ham istek gövdesi; {timestamp} ise yukarıdaki zaman damgasıdır.

Bu şartlardan herhangi birini karşılamayan bir istek, 401 hatasıyla reddedilir, Geçmiş ve sorun giderme bölümüne kaydedilir ve hiçbir zaman bir iş akışını başlatmaz.

3. Adım - Shopify Flow iş akışını oluşturun

  1. Shopify Flow'da bir iş akışı oluşturun ve Workflow Webhooks tetikleyicisini seçin.
  2. Olayları Kaydet seçeneğine basın, ardından Sanity’den bir test olayı gönderin (ya da Workflow Webhooks bölümündeki Test Gönder seçeneğini kullanın), böylece Shopify Flow verilerinizin yapısını öğrenebilir.
  3. Sahip olduğunuz her webhook aynı Shopify Flow tetikleyicisini çalıştırır; bu nedenle, bu iş akışını yalnızca Sanity ile sınırlı tutmak için **webhook **kimliğine ilişkin bir ilk koşul ekleyin. Kimlik, webhook sayfasında gösterilir.
  4. İşlemlerinizi ekleyin - bir müşteriyi etiketleyin, bir not ekleyin, şirket içi bir e-posta gönderin, bir meta alanı güncelleyin.
Shopify Flow
Shopify Flow'da “Bir tetikleyici seç” seçeneğini seçin, Workflow Webhooks bölümünü açın ve “Webhook Tetikleyicisi”ni seçin.
Bir Shopify Flow koşulu: Webhook kimliği, bir webhook’un kimliğine eşittir
Her iş akışının ilk adımı: webhook kimliğine ilişkin bir koşul; böylece iş akışı yalnızca bu webhook için çalıştırılır.
Tamamlanmış iş akışı: Webhook Tetikleyicisi, webhook kimliğine ilişkin bir koşul, ardından “Doğru” dalında dahili e-posta gönderme
Tamamlanmış iş akışı: tetikleyici, webhook kimliğine dayalı koşul ve ardından “True” dalında gerçekleştirilecek eyleminiz.

4. Adım - Uçtan uca test edin

Sanity'de gerçek bir olayı tetikleyin. Workflow Webhooks → History bölümünde, durum Success olarak belirtilen çağrıyı görmelisiniz. İmza yanlışsa, bunun yerine nedeni belirtilen bir hata kaydı alırsınız ve İmzalı webhook'ların doğrulanması, hangi adımın başarısız olduğunu tam olarak gösteren imza denetleyicisini açıklar.

Tarih bölümünde, istek başlıkları, veri yükü, durum, süre ve tanımlayıcılarıyla birlikte bir çağrı açıldı
Tarih bölümünde gerçekleştirilmiş bir olay: “Başarılı” durumu, Shopify Flow’un bunu kabul ettiği anlamına gelir.
İmza eşleşmiyor

Şu sırayla: gizli anahtar (en yaygın neden - fazladan bir boşluk ya da yanlış ortamdan gelen bir anahtar), gönderenin farklı bir uç noktanın gizli anahtarını kullanıp kullanmadığı ve Sanity ile uygulama arasında gövdeyi yeniden yazan herhangi bir şey olup olmadığı. İmzalar ham baytları kapsar; bu nedenle, JSON’u yeniden biçimlendiren bir proxy, imzaları bozar. Webhook sayfasındaki imza test aracı, imzalanmış olan metnin tam halini gösterir.

Her istekte 401 hatası alıyorum

Webhook’un kimlik doğrulama ayarının HMAC olarak ayarlandığını ve Sanity sağlayıcısının seçili olduğunu, gizli anahtarın girildiğini ve Sanity’nin, sondaki kod da dahil olmak üzere, uygulamanın gösterdiği şekilde tam olarak bu URL’ye veri gönderdiğini kontrol edin.

Geçmiş'te hiçbir şey görünmüyor

İstek hiç ulaşmadı. Sanity'de URL'yi tekrar kontrol edin ve Sanity'nin kendi iletim günlüğüne bakarak aldığı yanıtı inceleyin. 404 kodu, webhook'un yanlış veya silinmiş olduğunu; 429 kodu ise planınızın çağrı sınırını aştığınızı gösterir - bkz. Planlar ve kullanım.

İş akışı yanlış olaylar için çalışıyor

Mağazanızdaki her webhook, aynı Shopify Flow tetikleyicisini çalıştırır. İş akışının ilk adımı olarak **webhook **kimliğine bir koşul ekleyin ya da Sanity’den gönderdiğiniz olayları daraltın.

İlgili