الانتقال إلى المحتوى الرئيسي

نظرة عامة

توفر عدة تطوير البرمجيات SDK الخاصة بـ Benzinga بلغة TypeScript/JavaScript واجهةً معيارية مكوّنة من وحدات وقائمة على الأحداث للتفاعل مع واجهات برمجة التطبيقات API من Benzinga. وبما أنها مكتوبة بلغة TypeScript، فإن الـ SDK تعمل بسلاسة في كلٍّ من بيئات المتصفح و Node.js، مع تقديم تنفيذات محسَّنة تتضمن التخزين المؤقت، والمقارنة العميقة، وغير ذلك من القدرات المتقدمة.

الميزات الرئيسية

  • دعم TypeScript - دعم كامل لأنواع (types) وواجهات (interfaces) TypeScript
  • عالمي - يعمل في متصفحات الويب وبيئات Node.js على حدٍّ سواء
  • هندسة معيارية - ثبّت فقط الوحدات (modules) التي تحتاجها
  • معتمد على الأحداث - أنماط برمجة تفاعلية للبيانات في الوقت الفعلي
  • ميزات متقدمة - تخزين مؤقت مدمج، مقارنة عميقة، وتحسينات في الأداء
  • حديث - صياغة ES6+ مع دعم async/await

المتطلبات

  • الإصدار 14 من Node.js أو أحدث

التثبيت

تتبع عدة تطوير البرمجيات SDK معمارية قائمة على الوحدات. ابدأ بتثبيت وحدة الجلسة الأساسية:
ثم قم بتثبيت وحدات إضافية حسب الحاجة:

البدء

إعداد الجلسة

توفر الوحدة @benzinga/session الأساس لعملية المصادقة مع واجهات برمجة التطبيقات API الخاصة بـ Benzinga. تعتمد جميع الوحدات الأخرى على كائن Session هذا.

خيارات التهيئة

يقبل كائن Session عدة خيارات تهيئة لتخصيص سلوكه:

المفاهيم الجوهرية

تصميم معياري

يتم تجميع كل نطاق من نطاقات واجهة برمجة التطبيقات API الخاصة بـ Benzinga كوحدة npm مستقلة. يتيح لك هذا:
  • تثبيت ما تحتاج إليه فقط
  • تقليل حجم الحزمة
  • الحفاظ على فصل واضح بين المسؤوليات
  • تحديث الوحدات بشكل مستقل

معمارية قائمة على الأحداث

تستخدم عدة تطوير البرمجيات SDK نمطًا قائمًا على الأحداث للتعامل مع تدفقات البيانات الفورية والتحديثات:

التخزين المؤقت والأداء

يتضمن الـSDK آليات تخزين مؤقت مدمجة من أجل:
  • تقليل طلبات واجهة برمجة التطبيقات API غير الضرورية
  • تحسين زمن الاستجابة
  • تحسين استخدام النطاق الترددي
  • توفير بدائل للعمل في وضع عدم الاتصال

المقارنة العميقة

تتيح ميزات مقارنة البيانات المتقدمة ما يلي:
  • اكتشاف التغييرات في الكائنات المتداخلة
  • إدارة الحالة بكفاءة
  • مشغلات تحديث ذكية
  • تقليل مرات إعادة التصيير في تطبيقات واجهة المستخدم

الوحدات المتاحة

تم تنظيم عدة تطوير البرمجيات SDK في وحدات متخصصة تغطي مجالات مختلفة ضمن واجهة برمجة التطبيقات API:

الوحدات الأساسية

  • @benzinga/session - المصادقة وإدارة الجلسات (إلزامي)
  • @benzinga/calendar-data - أحداث calendar والإجراءات المؤسسية
  • @benzinga/news-data - المقالات الإخبارية وتحليلات السوق
  • @benzinga/quotes - الأسعار الفورية والمتأخرة
  • @benzinga/fundamentals - البيانات الأساسية والمالية للشركات

وحدات متخصصة

  • @benzinga/ratings - تقييمات المحللين والأسعار المستهدفة
  • @benzinga/options - نشاط الخيارات وتحليلاتها
  • @benzinga/transcripts - محاضر مكالمات الأرباح
  • @benzinga/logos - شعارات الشركات والعلامات التجارية
  • @benzinga/signals - إشارات التداول ومؤشراته

دعم TypeScript

عدة تطوير البرمجيات SDK مكتوبة بلغة TypeScript وتوفر تعريفات أنواع كاملة:

أمثلة على الاستخدام

جلب البيانات الأساسي

تدفقات البيانات في الوقت الفعلي

أحداث التقويم

الأساسيات المالية للشركة

الاستخدام في المتصفح

تعمل عدة تطوير البرمجيات SDK في بيئات المتصفح مع أدوات التجميع مثل Webpack وRollup وVite:

معالجة الأخطاء

عالِج الأخطاء بسلاسة باستخدام كتل try/catch:
التعامل بكفاءة مع النتائج المقسَّمة إلى صفحات:

استراتيجية التخزين المؤقت

استخدم ميزة التخزين المؤقت المدمجة لتحسين الأداء:

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

1. إعادة استخدام كائنات الجلسة

أنشئ مثيلًا واحدًا للجلسة وأعد استخدامه في جميع أنحاء تطبيقك:

2. متغيرات البيئة

خزِّن مفاتيح واجهة برمجة التطبيقات API بأمان في متغيرات البيئة:

3. سلامة الأنواع (Type Safety)

استفد من TypeScript لضمان تفاعلات آمنة من ناحية الأنواع مع واجهة برمجة التطبيقات API:

4. حدود الأخطاء

طبِّق حدود الأخطاء في بيئة الإنتاج:

الموارد

توثيق الوحدات

للحصول على توثيق مفصل للوحدات المحددة، راجع ملفات README الخاصة بكل حزمة:
  • @benzinga/session - المصادقة الأساسية والإعدادات
  • @benzinga/calendar-data - واجهة برمجة التطبيقات API لأحداث calendar
  • @benzinga/news-data - واجهة برمجة التطبيقات API للأخبار والمقالات
  • @benzinga/quotes - واجهة برمجة التطبيقات API للأسعار الآنية
  • @benzinga/fundamentals - واجهة برمجة التطبيقات API للأساسيات المالية والبيانات المالية

الدعم

للدعم الفني ولطلب مفتاح واجهة برمجة التطبيقات API، تواصل مع Benzinga عبر cloud.benzinga.com.

المساهمة

عدة تطوير البرمجيات SDK من Benzinga لـ JavaScript مفتوحة المصدر. نرحّب بالمساهمات! زُر مستودع GitHub لمزيد من المعلومات.