الانتقال إلى المحتوى الرئيسي
GET
/
api
/
v1
/
webhook
/
test
اختبار تسليم الـ Webhook
curl --request GET \
  --url https://api.benzinga.com/api/v1/webhook/test \
  --header 'Key: <api-key>'
{
  "status": "success"
}

​
نظرة عامة

استخدم نقطة النهاية هذه لإطلاق إرسال Webhook تجريبي إلى نقطة النهاية التي قمت بإعدادها. يتيح لك ذلك التحقق من أن تكامل الـ Webhook الخاص بك يعمل بشكل صحيح قبل بدء استلام بيانات الإنتاج الحية.

​
اختبار تكاملك

عند استدعاء نقطة النهاية هذه، سترسل Benzinga حمولة Webhook اختبارية إلى عنوان destination URL الذي قمت بتكوينه. يتبع هذا الإرسال الاختباري نفس التنسيق ومنطق إعادة المحاولة المستخدم في عمليات إرسال Webhook في بيئة الإنتاج.

​
ما الذي يمكنك توقعه

  1. استجابة فورية: تُرجِع واجهة برمجة التطبيقات API رمز الحالة 200 إذا تم تشغيل الإرسال التجريبي بنجاح
  2. حمولة تجريبية: تتلقى جهة اتصال الـ webhook الخاصة بك حمولة تجريبية بنفس تنسيق بيانات الإنتاج
  3. رؤوس التسليم: يتضمن الإرسال التجريبي الرأس X-BZ-Delivery تمامًا كما في عمليات الإرسال في بيئة الإنتاج

​
التحقق من عملية التكامل

استخدم هذا الـ endpoint للتأكد من:
  • أن نقطة نهاية الـ webhook الخاصة بك متاحة للعامة
  • أن نقطة النهاية الخاصة بك يمكنها تحليل تنسيق حمولة الـ webhook بشكل صحيح
  • أن نقطة النهاية الخاصة بك تُرجع رموز حالات مناسبة (2xx للنجاح)
  • أن نقطة النهاية الخاصة بك تستجيب ضمن مهلة 30 ثانية
  • أن منطق الـ idempotency لديك يتعامل بشكل صحيح مع ترويسة X-BZ-Delivery وحقل الحمولة id

​
أفضل الممارسات

  • اختبر أولًا باستخدام نقاط نهاية Webhook غير مخصّصة للإنتاج
  • تحقق من أن نقطة النهاية تستجيب برموز حالة 200 أو 204
  • تأكد من أن نظام التسجيل والمراقبة لديك يسجّل عملية التسليم التجريبية
  • تحقق من أن منطق إزالة التكرار لديك يعمل مع معرّف التسليم التجريبي
  • اختبر سيناريوهات الأخطاء عن طريق إرجاع رموز حالة خطأ بشكل مؤقت

​
استكشاف الأخطاء وإصلاحها

​
424 خطأ في التسليم

إذا تلقيت رمز حالة 424، فهذا يعني أنّ النظام لم يتمكّن من تسليم الحمولة الاختبارية إلى نقطة نهاية الوجهة. من الأسباب الشائعة:
  • عنوان URL الخاص بالوجهة غير قابل للوصول بشكل عام
  • نقطة نهاية الوجهة تُرجع رموز حالات أخطاء
  • مشاكل في اتصال الشبكة
  • أخطاء في شهادة SSL/TLS على نقطة نهاية الوجهة

​
400 طلب غير صالح

تحقق من أن جميع المعاملات المطلوبة مُقدَّمة ومُنسَّقة بشكل صحيح:
  • يجب أن يكون destination عنوان URL صالحًا باستخدام بروتوكول HTTPS
  • يجب أن تكون قيمة version هي webhook/v1
  • يجب أن تكون قيمة kind هي News/v1
{
  "status": "success"
}

التفويضات

​
Key
string
header
مطلوب

مفتاح واجهة برمجة التطبيقات (API) الخاص بك من Benzinga

معلمات الاستعلام

​
destination
string<uri>
مطلوب

عنوان url لنقطة نهاية webhook التي ستُرسل إليها بيانات الاختبار

​
version
enum<string>
افتراضي:webhook/v1
مطلوب

إصدار واجهة برمجة التطبيقات API الحالي: webhook/v1

الخيارات المتاحة:
webhook/v1
​
kind
enum<string>
افتراضي:News/v1
مطلوب

يحدّد نوع الرسالة في حقل kind. القيمة الحالية هي News/v1

الخيارات المتاحة:
News/v1
​
token
string

حدِّد رمز الوصول ليتم تهيئة البيانات للاستخدام في بيئة الإنتاج

الاستجابة

نجاح - تم إرسال اختبار تسليم Webhook بنجاح

​
status
string
مثال:

"success"