API कुंजियाँ प्रोजेक्ट-विशिष्ट हैं और प्रोजेक्ट संसाधनों तक पहुँच प्रदान करती हैं। इन्हें सुरक्षित रखें और नियमित रूप से रोटेट करें।
API कुंजियाँ सूची
API कुंजियाँ सूची इस प्रोजेक्ट के लिए बनाई गई सभी कुंजियाँ प्रदर्शित करती है। एक विशिष्ट कुंजी खोजने के लिए नाम या कुंजी से खोजें फ़ील्ड का उपयोग करें। प्रत्येक प्रविष्टि निम्नलिखित कॉलम दिखाती है:| कॉलम | विवरण |
|---|---|
| नाम | API कुंजी को सौंपा गया नाम, इसके प्रकार का संकेत देने वाले बैज के साथ (विशेषाधिकृत या सिस्टम)। |
| API कुंजी | कुंजी मान का छोटा पूर्वावलोकन। पूर्ण कुंजी अपने क्लिपबोर्ड में कॉपी करने के लिए कॉपी आइकन का उपयोग करें। |
| बनाया गया | कुंजी बनाने की तिथि और समय। |
| क्रियाएँ | उपयोगकर्ता-निर्मित कुंजियों के लिए हटाएँ लिंक। सिस्टम कुंजियाँ संरक्षित दिखाती हैं और हटाई नहीं जा सकतीं। |
कुंजी प्रकार
एक नई API कुंजी बनाते समय, आपको निम्नलिखित में से एक कुंजी प्रकार चुनना होगा:| प्रकार | विवरण |
|---|---|
| विशेषाधिकृत कुंजी | पूर्ण प्रोजेक्ट पहुँच। चैट्स भेज सकती है और प्रोजेक्ट संसाधन, एजेंट्स, वर्कफ़्लोज़ और सेटिंग्स संपादित या हटा सकती है। इसका उपयोग विश्वसनीय इंटीग्रेशंस और सर्वर-टू-सर्वर ऑटोमेशन के लिए करें। |
| लॉक्ड-डाउन दर्शक कुंजी | केवल-पठन प्रोजेक्ट पहुँच प्लस चैट रनटाइम (बॉट इंटरैक्शन)। प्रोजेक्ट संसाधन, एजेंट्स, वर्कफ़्लोज़ या सेटिंग्स संपादित या हटा नहीं सकती। सीमित दायरे के वितरण जैसे Teams या चैनल बॉट प्रमाणीकरण के लिए बनाई गई है। |
एक नई API कुंजी बनाएँ
एक कुंजी प्रकार चुनें
आवश्यक पहुँच स्तर के आधार पर विशेषाधिकृत कुंजी या लॉक्ड-डाउन दर्शक कुंजी चुनें।
कुंजी का नाम दें
कुंजी नाम फ़ील्ड में एक वर्णनात्मक नाम दर्ज करें जो कुंजी के उद्देश्य को स्पष्ट रूप से पहचानता हो।
API कुंजी हटाएँ
ऑटोमेटर कुंजी एक सिस्टम कुंजी है जो प्रत्येक प्रोजेक्ट के लिए स्वचालित रूप से बनाई जाती है और हटाई नहीं जा सकती। आपके द्वारा बनाई गई अन्य सभी API कुंजियाँ आवश्यकता के अनुसार हटाई जा सकती हैं।- सेटिंग्स → API कुंजियाँ टैब में, उस कुंजी के लिए हटाएँ लिंक का चयन करें जिसे आप हटाना चाहते हैं।
- पॉपअप में हटाने की पुष्टि करें।
सर्वोत्तम प्रथाएँ
- सही कुंजी प्रकार का उपयोग करें: विशेषाधिकृत कुंजियों का उपयोग केवल विश्वसनीय, सर्वर-साइड इंटीग्रेशंस के लिए करें। सार्वजनिक रूप से सामने आने वाले या चैनल बॉट तैनाती के लिए लॉक्ड-डाउन दर्शक कुंजियों का उपयोग करें।
- स्पष्ट नामकरण: ऐसे वर्णनात्मक नामों का उपयोग करें जो स्पष्ट रूप से कुंजी के उद्देश्य और इससे संबंधित इंटीग्रेशन को दर्शाते हों।
- नियमित रूप से रोटेट करें: अनधिकृत पहुँच के जोखिम को कम करने के लिए कुंजियों को समय-समय पर हटाएँ और पुनर्जनरित करें।