Ana içeriğe atla
Webhooks entegrasyonu geliştiriciler içindir. Foliant’ta bir şey olduğunda, seçtiğiniz bir HTTPS adresine bir JSON olayı gönderir. Böylece kendi sisteminiz buna tepki verebilir; örneğin her fatura PDF’ini arşivleyebilir veya tamamlanan bir dışa aktarmayı alabilir. Webhooks beta aşamasındadır. Ayarlar › Entegrasyonlar bölümünde görmüyorsanız mağazanıza henüz sunulmamıştır. Erişim hakkında bilgi almak için destek ekibiyle iletişime geçin.

Olaylar

Webhook’ları bağlayın

  1. Foliant’ta Ayarlar › Entegrasyonlar bölümüne gidin.
  2. Webhooks üzerinde Bağla’ya tıklayın.
  3. Ayarları doldurun:
  4. Bağla’ya tıklayın.
URL’yi, anahtarı ve olayları daha sonra entegrasyonun sayfasındaki Ayarlar bölümünden değiştirebilirsiniz.

Her isteğin içeriği

Foliant, JSON gövdeli bir POST isteği gönderir:

document.generated verileri

  • template: şablonun uuid ve name değerleri.
  • document_type: invoice, credit_note, quote veya diğer belgeler için boş.
  • order: siparişin id, name ve type değerleri (siparişler veya taslak siparişler).
  • refund_id ve fulfillment_id, belge bir iade veya gönderim içinse.
  • document_number ve issued_at, numaralı belgeler için.
  • source: belgenin nasıl oluşturulduğu; örneğin download, admin_download, export veya email.
  • export: belge bir dışa aktarmanın parçasıysa dışa aktarmanın kimliği.
  • generated_at.

export.completed verileri

  • export: dışa aktarmanın uuid, order_type, template_uuids değerleri, orders sayısı, orders_skipped (seçildikten sonra silinen siparişler) ve documents, requested_by (merchant veya customer) ve completed_at.
  • download_url: dışa aktarmayı indirme bağlantısı ve bu bağlantının çalışmayı durduracağı zaman olan download_url_expires_at.
  • download_expires_at: dışa aktarmanın kendisinin sona ereceği zaman.
Olaylar müşteri e-posta adreslerini değil, kimlikleri ve sayıları içerir.

Başlıklar

İmzayı doğrulayın

İmza; zaman damgası, bir nokta ve ham istek gövdesinin (<timestamp>.<body>) imzalama anahtarınız kullanılarak hesaplanan onaltılık HMAC-SHA256 değeridir. İmzayı kendi tarafınızda hesaplayın ve X-Foliant-Signature içindeki sha256= sonrasındaki değerle karşılaştırın. Ham gövdeyi tam olarak alındığı şekilde kullanın.

Yanıtlar ve yeniden denemeler

  • Herhangi bir 2xx yanıtı teslim edildi olarak sayılır.
  • Uç noktanız 5xx hatası, 408 veya 429 döndürürse ya da 10 saniye içinde yanıt vermezse Foliant daha sonra yeniden dener. Her seferinde daha uzun bekler ve en fazla 5 deneme yapar.
  • Diğer 4xx yanıtları kesindir: Foliant bunları yeniden denemez.
  • Her olay, belge veya dışa aktarma başına bir kez teslim edilir. Başarılı bir teslimattan sonra yeniden denemeler olayı asla ikinci kez göndermez.
Her teslimat, entegrasyonun sayfasındaki Etkinlik bölümünde görünür. Burada başarısız bir teslimat için Yeniden dene’ye tıklayabilirsiniz. Entegrasyon etkinliği sayfasına bakın.

İlgili makaleler