GitHub'ı Shopify Flow'a nasıl bağlayabilirim?

GitHub, bir depoda veya kuruluşta bir olay meydana geldiğinde (push, sürüm yayınlama, sorun, çekme isteği, iş akışı çalıştırma gibi) 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, şirket içi e-posta gönderebilir, meta alanı güncelleyebilir - kısacası Shopify Flow'un yapabileceği her şeyi yapabilir.

Bu kılavuz, tüm süreci - GitHub’ın gönderimi, Workflow Webhooks’un alımı ve doğrulaması, Shopify Flow’un harekete geçmesi - her istekte GitHub’ın HMAC imzası kontrol edilerek kurar; böylece iş akışınızı yalnızca GitHub başlatabilir.

Neler yapabileceğiniz

• Ürün verilerini değiştiren bir sürüm yayınlandığında, pazarlama ekibinize e-posta gönderin.
• Her sürüm yayınlandığında, mevcut derleme veya tema sürümünü mağazanın bir meta alanına yazın.
• Diğer olaylar için halihazırda kullandığınız aynı Shopify Flow’u kullanarak, zamanlanmış bir iş akışının çalıştırılması başarısız olduğunda personeli uyarın.

Gönderilebilecek tipik olaylar: push, release (yayınlandı), issues (açıldı, kapatıldı), workflow_run (tamamlandı).

Başlamadan önce

• Shopify mağazanıza kurulan Workflow Webhooks.
• Shopify Flow, Shopify Uygulama Mağazasından ücretsiz olarak indirilip kuruldu.
• Webhook oluşturma iznine sahip bir GitHub 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 GitHub events gibi.
2. Kimlik Doğrulama bölümünden HMAC'yi seçin.
3. İmza sağlayıcısı bölümünden GitHub’ı seçin. Uygulama, başlık, algoritma, imzalı veri yükü 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 - GitHub'da uç noktayı ekleyin

Depoda (veya kuruluşta), Ayarlar -> Webhook'lar -> Webhook ekle seçeneğini açın, URL'yi Yük URL'si olarak yapıştırın, içerik türünü application/json olarak ayarlayın ve Gizli Bilgi alanını doldurun.

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

GitHub webhook'unda belirlediğiniz gizli anahtar (Ayarlar -> Webhook'lar -> Gizli Anahtar).

GitHub'un 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 bölümündeki webhook’un “Secret” alanına yapıştırın ve kaydedin. O andan itibaren her GitHub teslimatı, Shopify Flow’a ulaşmadan önce doğrulanır.

Bu kontrolün amacı

Ne	Değer
İmza başlığı	X-Hub-Signature-256
İmzanın bulunduğu yer	sha256= önekinden sonraki başlık değeri
Neyin imzalandığı	{body}
İmza	HMAC-SHA256, onaltılık kodlanmış
Zaman damgası	Bu gönderen tarafından kullanılmamaktadır
Tekrar oynatma koruması	Yok - bu gönderen zaman damgasını imzalamadığından, 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övdesidir.

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 GitHub'dan 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 GitHub 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.

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

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

İlgili

• İmzalı webhook'ların doğrulanması - doğruladığımız her sağlayıcı ve doğrulamadığımız bir sağlayıcıyı nasıl tanımlayacağımız.
• Yük haritalama ve Shopify Flow değişkenleri - yükten doğru alanları alıp Shopify Flow'a aktarma.
• Yinelenen teslimat koruması - GitHub bir teslimatı yeniden denediğinde ne olur?
• Geçmiş ve sorun giderme - her isteğin günlüğü; tekrar oynatma özelliği ile.