मूल बातें
एंडपॉइंट संरचना
सभी REST API एंडपॉइंट इस बेस URL के माध्यम से एक्सेस किए जाते हैं:
https://api.finlight.me
एंडपॉइंट मानक HTTP विधियों का उपयोग करके संरचित होते हैं और पैरामीटर को क्वेरी स्ट्रिंग के रूप में भेजे जाने की अपेक्षा करते हैं।
API वर्ज़निंग
पश्च-संगतता सुनिश्चित करने के लिए REST API का वर्ज़न रखा गया है। वर्तमान वर्ज़न v2 है। सभी एंडपॉइंट URL में वर्ज़न संख्या शामिल करते हैं:
https://api.finlight.me/v2/...
इससे मौजूदा एकीकरण को बाधित किए बिना भविष्य के अपडेट संभव होते हैं।
प्रमाणीकरण हेडर
X-API-KEY हेडर में अपनी API कुंजी शामिल करके अपने REST API अनुरोधों को प्रमाणित करें:
X-API-KEY: YOUR_API_KEY
यदि आप हमारी क्लाइंट लाइब्रेरी का उपयोग कर रहे हैं, तो यह हेडर आपके लिए स्वतः संभाला जाता है। आप अपनी API कुंजी finlight डैशबोर्ड में प्राप्त कर सकते हैं।