تمت ترجمة هذه الصفحة آليًا. النسخة الإنجليزية هي المصدر وقد تكون أكثر دقة أو أحدث. العرض بالإنجليزية

مكتبات العملاء

تنشر finlight ثماني مكتبات عملاء رسمية. تغلّف كل منها واجهات REST وWebSocket وwebhook نفسها الموثّقة في بقيّة هذه الصفحات، فيمكنك اختيار المكتبة التي تناسب بيئتك التقنية بدلًا من كتابة استدعاءات HTTP يدويًا.

اللغةالحزمةالمتطلّباتالبثّ
TypeScript / JavaScriptfinlight-client (npm)Node.jsنعم
Pythonfinlight-client (PyPI)Python 3.7+نعم
Gogithub.com/callbk/finlight-client-goGo 1.23+نعم
.NET / C#Finlight.Client (NuGet).NET 8+نعم
Java / Kotlinme.finlight:finlight-client (Maven)Java 17+نعم
PHPfinlight/client (Packagist)PHP 8.1+لا
Rubyfinlight-client (RubyGems)Ruby 3.2+نعم
Rustfinlight-client (crates.io)Rust 1.85+نعم

ما يوفّره كل عميل

بُنيت المكتبات وفق المواصفة نفسها، لذا فإنّ تبديل اللغة لا يغيّر المفاهيم التي تتعامل معها:

  • REST: ابحث في المقالات، واجلب مقالًا واحدًا عبر رابطه، واعرض قائمة المصادر المتاحة — راجع نقاط النهاية.
  • البثّ في الوقت الفعلي: تدفّق WebSocket المُحسّن والخام معًا، مُتاحًا بنوع البثّ المألوف في كل لغة (المُكرِّرات غير المتزامنة، والقنوات، وStream). ويُدار إعادة الاتصال وآلية ping/pong لإبقاء الاتصال حيًّا وتدوير الاتصال الاستباقي نيابةً عنك — راجع أساسيات WebSocket.
  • المرونة: إعادة المحاولة مع تراجع أسّي عند استجابات 429 و5xx، بحيث لا تظهر الأعطال المؤقتة وحدود المعدّل كأخطاء في الكود الخاص بك.
  • التحقّق من webhook: فحص توقيع HMAC-SHA256 مع الحماية من إعادة التشغيل، بما يطابق مصادقة Webhook.
  • المصادقة: تمرّر مفتاح API الخاص بك إلى المُنشئ، ويرسله العميل في ترويسة X-API-KEY مع كل طلب.

الاستثناء المقصود الوحيد هو عميل PHP، الذي لا ينفّذ البثّ عبر WebSocket — فنموذج الطلب/الاستجابة في PHP لا يناسب اتصالًا طويل الأمد. استخدم webhooks للتسليم الفوري إلى تطبيق PHP.

لا شيء في هذه المكتبات يتمتّع بامتيازات خاصّة: فكل ما تفعله متاح عبر HTTP وWebSocket العاديين، ومن ثمّ يبقى cURL أو أي عميل HTTP خيارًا مدعومًا بالكامل.

التثبيت

يقرأ كل عميل مفتاح API الخاص بك من المُنشئ ويرسله في ترويسة X-API-KEY. احصل على مفتاح من لوحة تحكم finlight.

التثبيت

# npm — يُنشر أيضًا على JSR باسم @finlight/client
npm install finlight-client

إذا كنت تبني باستخدام Maven بدلًا من Gradle، فأعلِن الإحداثية نفسها:

<dependency>
    <groupId>me.finlight</groupId>
    <artifactId>finlight-client</artifactId>
    <version>0.1.0</version>
</dependency>

مستودعات المصدر

يُطوَّر كل عميل بشكل مفتوح تحت رخصة MIT. والمساهمات عبر المشكلات وطلبات السحب مرحّب بها.

ما الخطوة التالية؟