⚙️ API कुंजियां
API कुंजियां बनाएं और प्रबंधित करें जो बाहरी सिस्टम (ई-कॉमर्स प्लेटफ़ॉर्म, थर्ड-पार्टी ऐप्स) को आपके LKG for Billing उत्पाद कैटलॉग और डेटा तक पहुंचने की अनुमति देती हैं।
Administration → API Keys (Settings के भीतर) पर नेविगेट करें।
API कुंजी प्रबंधन के लिए Settings में External API Access सक्षम होना आवश्यक है।
अवलोकन
API कुंजियां ऐसी क्रेडेंशियल्स हैं जो बाहरी एप्लिकेशनों को आपके व्यवसाय के API एंडपॉइंट कॉल करने के लिए अधिकृत करती हैं। प्रत्येक कुंजी को टेस्ट या लाइव मोड तक सीमित किया जा सकता है, रेट-लिमिटेड किया जा सकता है, और विशिष्ट ऑरिजिन तक प्रतिबंधित किया जा सकता है।
तालिका कॉलम
| कॉलम | विवरण |
|---|---|
| नाम | कुंजी के लिए प्रदर्शन नाम |
| मोड | Test या Live |
| कुंजी | मास्क की गई कुंजी — केवल अंतिम 4 अक्षर दिखाती है (उदा., ••••••••abcd) |
| रेट लिमिट | प्रति मिनट अधिकतम API अनुरोध |
| अनुमत ऑरिजिन | इस कुंजी का उपयोग करने की अनुमति वाले डोमेन |
| स्थिति | सक्रिय या निष्क्रिय |
| समाप्ति | कुंजी की समाप्ति तिथि (यदि सेट है) |
| कार्रवाइयां | कॉपी, पुनः जनरेट, सक्रिय टॉगल, रद्द करें |
API कुंजी बनाना
- + New API Key पर क्लिक करें
- भरें:
| फ़ील्ड | आवश्यक | विवरण |
|---|---|---|
| नाम | हां | वर्णनात्मक लेबल (उदा., "Shopify Integration") |
| मोड | हां | Test (सैंडबॉक्स) या Live (प्रोडक्शन) |
| रेट लिमिट | नहीं | प्रति मिनट अधिकतम अनुरोध (सीमा न रखने के लिए खाली छोड़ें) |
| अनुमत ऑरिजिन | नहीं | इस कुंजी का उपयोग करने की अनुमति वाले, कॉमा से अलग किए गए डोमेन (उदा., shop.example.com) |
| विवरण | नहीं | यह कुंजी किसलिए उपयोग होती है, इस पर टिप्पणियां |
- Save पर क्लिक करें
- पूरी कुंजी केवल एक बार दिखाई जाती है — तुरंत इसे कॉपी करें
पूरी API कुंजी केवल बनाते समय एक बार दिखाई जाती है। यदि आप इसे खो देते हैं, तो आपको कुंजी को पुनः जनरेट करना होगा (जो तुरंत पुरानी कुंजी को रद्द कर देता है)।
कुंजी कॉपी करना
मास्क की गई कुंजी कॉपी करने के लिए पंक्ति पर Copy आइकन पर क्लिक करें। पूरी कुंजी फिर से पाने के लिए, Regenerate का उपयोग करें।
कुंजी पुनः जनरेट करना
- कुंजी की पंक्ति पर Regenerate पर क्लिक करें
- पुष्टि करें — पुरानी कुंजी तुरंत रद्द कर दी जाती है
- नई पूरी कुंजी एक बार दिखाई जाती है — तुरंत इसे कॉपी करें
सक्रिय / निष्क्रिय टॉगल करना
किसी कुंजी को हटाए बिना सक्षम या अक्षम करने के लिए Active टॉगल पर क्लिक करें। निष्क्रिय कुंजियों को API द्वारा अस्वीकार कर दिया जाता है।
कुंजी रद्द करना
किसी कुंजी को स्थायी रूप से हटाने के लिए Revoke पर क्लिक करें। इसे पूर्ववत नहीं किया जा सकता। रद्द की गई कुंजी का उपयोग करने वाला कोई भी इंटीग्रेशन तुरंत एक्सेस खो देगा।
सुरक्षा सर्वोत्तम प्रथाएं
- टेस्ट और प्रोडक्शन वातावरण के लिए अलग-अलग कुंजियों का उपयोग करें
- Allowed Origins को केवल आवश्यक डोमेन तक सीमित रखें
- दुरुपयोग रोकने के लिए Rate Limits सेट करें
- Regenerate का उपयोग करके समय-समय पर कुंजियां घुमाएं
- अब उपयोग में न होने वाली कुंजियों को रद्द करें