Skip to navigation

Webhooks و SDKs

View as Markdown

Webhooks لإعلام الواجهة الخلفية لديك بشأن أحداث العمل. استخدمها مع استعلامات API حتى لا يترك التسليم المتأخر أو المفقود سجلاتك دون حل.

التحقق قبل المعالجة

يتضمن التسليم الحالي X-Webhook-Signature وX-Webhook-Timestamp. يستخدم التوقيع HMAC-SHA256 فوق نص رأس الطابع الزمني ونقطة ونص الطلب الأولي الدقيق. قيمة رأسها لها الشكل sha256=<HEX_SIGNATURE>.

  1. احتفظ بالجسم الخام قبل التحليل JSON.
  2. التحقق من صحة الطابع الزمني باستخدام تفاوت الساعة المتفق عليه.
  3. تحقق من التوقيع باستخدام السر webhook باستخدام مقارنة الوقت الثابت.
  4. عندها فقط قم بتفسير الحمولة وتحديث سجلات الأعمال.

إعادة التنسيق التي تم تحليلها JSON قبل التحقق تؤدي إلى تغيير البايتات الموقعة. يستخدم التحقق Webhook سر webhook، وليس سر الطلب API أو مفتاح تفويض العميل.

تخزين وإلغاء التكرار

يتضمن المغلف event_id، event_type، created_at، tenant_id و data. بالنسبة لعمليات تسليم الأحداث العادية، استخدم هوية الحدث التي تم التحقق منها مع نقطة النهاية أو سياق مساحة العمل الخاصة بك لمنع التطبيق المتكرر. استمر في اتخاذ هذا القرار تلقائيًا مع تحديث الأعمال الناتج، أو قم بإدراج الحدث الذي تم التحقق منه بشكل دائم قبل الإقرار به.

يتم توفير X-Webhook-Idempotency-Key أيضًا لعمليات التسليم العادية للبريد الصادر. إنها بيانات تعريف التسليم، وليست حقل حمولة موقع بشكل مستقل. لا تدع الرأس المتغير يتسبب في نفس الحدث الذي تم التحقق منه لنقل الأموال مرتين. قد يكون لعمليات التسليم الاختبارية والعمليات اليدوية معرفات مختلفة أو قد يتم حذف هذا الرأس.

قم بإرجاع استجابة ناجحة بعد قبول الحدث بشكل دائم. تصميم للتكرارات والأحداث المؤجلة أو الخارجة عن الترتيب. لا يعد الطابع الزمني للتسليم وقتًا مضمونًا لحدوث العمل. استعلم عن المورد الأساسي عندما يتعارض حدث مع نتيجة معروفة لاحقًا.

اختر حزمة التكامل

عائلة الحزمةنطاق التنفيذ الحالي
اذهب وبيثون API SDKsالعنوان وموارد الإيداع والسحب وتوقيع الطلب والمساعدين ذوي الصلة
اذهب ومساعدي Node.js وPython webhookWebhook مساعدات التحقق من التوقيع وتكامل الإطار

هذه هي نطاقات تنفيذ المصدر، وليست تأكيدًا لتوفر تسجيل الحزمة أو الإصدار العام. احصل على الحزمة المطابقة للإصدار وتعليمات التثبيت الخاصة بها أثناء الإعداد. قد تتطلب الموارد الأخرى مكالمات مباشرة API؛ لا تستنتج عميل API كاملاً من وجود حزمة webhook.

اختبار مسار الاستلام

اختبر تسليمًا صالحًا، ونصًا معدلاً، وتوقيعًا غير صالح، وطابعًا زمنيًا قديمًا، وحدثًا مكررًا، وإعادة تشغيل جهاز الاستقبال. قم بتأكيد ترتيبات إعادة المحاولة وإعادة التشغيل مع بيئة التكامل. يجب أن تؤدي عمليات الاسترجاعات المفقودة إلى المصالحة، وليس طلب سحب ثانٍ.