الانتقال إلى المحتوى الرئيسي
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 تمامًا مثل عمليات الإرسال في بيئة الإنتاج

​
تحقّق من تكاملك

استخدم نقطة النهاية هذه للتأكد مما يلي:
  • نقطة نهاية 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,
Signals/v1,
Earnings/v1,
Ratings/v1,
Dividends/v1,
IPOs/v1,
Guidance/v1,
Splits/v1,
OptionActivity/v1,
Conference/v1,
Economics/v1,
Offerings/v1,
MA/v1,
Retail/v1,
FDA/v1,
WIIMs/v1,
SECInsiderTransaction/v1,
GovernmentTrade/v1
​
token
string

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

الاستجابة

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

​
status
string
مثال:

"success"