ventic API कुंजी कैसे उत्पन्न करें?
ventic प्लेटफ़ॉर्म के साथ एकीकरण के लिए अनुरोधों को प्रमाणित करने के लिए एक API कुंजी की आवश्यकता होती है। ये कुंजियाँ आपके संगठन के लिए अद्वितीय हैं और आपके उत्पाद कैटलॉग और कॉमर्स सेवाओं तक सुरक्षित पहुँच प्रदान करती हैं।
API कुंजियाँ प्रबंधित करने का तरीका यहाँ दिया गया है:
1. डेवलपर डैशबोर्ड (Developer Dashboard) तक पहुँचें
अपने ventic खाते में लॉग इन करें और सेटिंग्स > डेवलपर (Settings > Developers) अनुभाग पर जाएँ। वहां आपको "API Keys" टैब मिलेगा।
2. एक नई कुंजी उत्पन्न करें
नई कुंजी बनाने के लिए:
- “Create API Key” बटन पर क्लिक करें।
- कुंजी को एक वर्णनात्मक नाम दें (उदाहरण के लिए, "Production - Main Store" या "Testing - Rahul")।
- अनुमति क्षेत्र (Scopes) चुनें। हम अनुशंसा करते हैं कि कुंजियों को केवल आवश्यक अनुमतियाँ ही दी जाएँ (न्यूनतम विशेषाधिकार का सिद्धांत)।
- “Generate” पर क्लिक करें।
3. कुंजी को सुरक्षित रूप से स्टोर करें
उत्पन्न होने के बाद, कुंजी आपको केवल एक बार दिखाई जाएगी।
- महत्वपूर्ण: कुंजी को कॉपी करें और सुरक्षित स्थान पर सहेजें (जैसे कि पासवर्ड मैनेजर या आपके बुनियादी ढांचे के भीतर एक सुरक्षित कुंजी स्टोर)।
- नोट: सुरक्षा कारणों से, विंडो बंद करने के बाद ventic फिर से पूरी कुंजी नहीं दिखाएगा।
4. अनुरोधों में कुंजी का उपयोग करें
ventic API इंटरफ़ेस पर भेजे जाने वाले सभी अनुरोधों में HTTP हेडर X-API-Key में API कुंजी शामिल होनी चाहिए।
cURL के उपयोग का उदाहरण:
curl -X GET "https://api.ventic.ai/v1/products" \
-H "X-API-Key: your_api_key_here" \
-H "Accept: application/json"
5. कुंजियों का रोटेशन और निरस्तीकरण (Revocation)
यदि आपको संदेह है कि कोई कुंजी लीक हो गई है, तो आपको उसे तुरंत निरस्त करना चाहिए।
- कंट्रोल पैनल में, उस कुंजी का चयन करें जिसे आप हटाना चाहते हैं और “Revoke” (निरस्त करें) पर क्लिक करें।
- निरस्त करने के बाद, उस कुंजी का उपयोग करने वाला कोई भी अनुरोध अस्वीकार कर दिया जाएगा।
- एक नई कुंजी उत्पन्न करें और अपने सिस्टम कॉन्फ़िगरेशन को अपडेट करें।
सुरक्षा सर्वोत्तम प्रथाएं
- API कुंजियों को कभी भी सोर्स कोड (जैसे GitHub) में प्रकाशित न करें। एनवायरनमेंट वेरिएबल्स का उपयोग करें।
- परीक्षण और उत्पादन वातावरण के लिए अलग-अलग कुंजियों का उपयोग करें।
- सक्रिय कुंजियों की सूची की नियमित रूप से समीक्षा करें और उन कुंजियों को हटा दें जो अब उपयोग में नहीं हैं।
यदि आपको एकीकरण में सहायता की आवश्यकता है, तो हमारी तकनीकी टीम से support@ventic.ai पर संपर्क करें।