Skip to main content
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 تجريبية إلى عنوان URL الوجهة destination الذي قمت بإعداده. يتبع هذا التسليم التجريبي نفس التنسيق ومنطق إعادة المحاولة المستخدم في عمليات تسليم 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، Earnings/v1، Ratings/v1، إلخ)
{
  "status": "success"
}

Authorizations

​
Key
string
header
required

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

Query Parameters

​
destination
string<uri>
required

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

​
version
enum<string>
default:webhook/v1
required

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

Available options:
webhook/v1
​
kind
enum<string>
default:News/v1
required

يُحدِّد قيمة الحقل kind في حمولة الاختبار

Available options:
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

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

Response

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

​
status
string
Example:

"success"