यह पृष्ठ मशीन द्वारा अनुवादित है। अंग्रेज़ी संस्करण मूल स्रोत है और अधिक सटीक या अधिक अद्यतन हो सकता है। अंग्रेज़ी में देखें

क्लाइंट लाइब्रेरी

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 फ़ीड, जो भाषा के मुहावरेदार स्ट्रीम प्रकार (async इटरेटर, चैनल, Stream) के रूप में उपलब्ध हैं। पुनः कनेक्शन, ping/pong कीप-अलाइव और सक्रिय कनेक्शन रोटेशन आपके लिए संभाले जाते हैं — WebSocket मूल बातें देखें।
  • लचीलापन: 429 और 5xx प्रतिक्रियाओं पर एक्सपोनेंशियल बैकऑफ़ के साथ पुनः प्रयास, ताकि अस्थायी विफलताएँ और दर सीमाएँ आपके कोड में त्रुटियों के रूप में सामने न आएँ।
  • Webhook सत्यापन: रीप्ले सुरक्षा के साथ HMAC-SHA256 हस्ताक्षर जाँच, जो Webhook प्रमाणीकरण से मेल खाती है।
  • प्रमाणीकरण: आप अपनी API कुंजी कंस्ट्रक्टर को देते हैं और क्लाइंट उसे हर अनुरोध पर X-API-KEY हेडर के रूप में भेजता है।

एकमात्र जानबूझकर रखा गया अपवाद PHP क्लाइंट है, जो WebSocket स्ट्रीमिंग लागू नहीं करता — PHP का अनुरोध/प्रतिक्रिया मॉडल दीर्घकालिक कनेक्शन के लिए उपयुक्त नहीं है। PHP एप्लिकेशन में पुश डिलीवरी के लिए webhooks का उपयोग करें।

लाइब्रेरी में कुछ भी विशेषाधिकार प्राप्त नहीं है: वे जो कुछ भी करती हैं वह सादे HTTP और WebSocket पर उपलब्ध है, इसलिए cURL या कोई भी HTTP क्लाइंट पूरी तरह समर्थित विकल्प बना रहता है।

इंस्टॉल करें

हर क्लाइंट आपकी API कुंजी कंस्ट्रक्टर से पढ़ता है और उसे X-API-KEY हेडर के रूप में भेजता है। finlight डैशबोर्ड में एक कुंजी प्राप्त करें।

इंस्टॉल करें

# npm — JSR पर @finlight/client के रूप में भी प्रकाशित
npm install finlight-client

यदि आप Gradle के बजाय Maven से बिल्ड करते हैं, तो वही कोऑर्डिनेट घोषित करें:

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

स्रोत रिपॉजिटरी

हर क्लाइंट MIT लाइसेंस के तहत खुले रूप में विकसित किया जाता है। इश्यू और पुल रिक्वेस्ट का स्वागत है।

आगे क्या?