API key प्रबंधन
API key एक एप्लिकेशन क्रेडेंशियल है। यह आपके वर्कस्पेस से जुड़ी होती है, और इसे रखने वाला एप्लिकेशन अपने असाइन किए गए स्कोप के भीतर Bird API को कॉल कर सकता है। आप डैशबोर्ड में या API के ज़रिए keys प्रबंधित कर सकते हैं। पूर्ण तकनीकी कॉन्ट्रैक्ट के लिए Authentication & API keys देखें।
Keys कहाँ होती हैं
API keys खोलें, जो साइडबार में नीचे की ओर Webhooks और Logs के साथ पिन की गई है। यह पेज हर key का नाम, मास्क्ड प्रीफ़िक्स, स्कोप, स्टेटस, एक्सपायरेशन और अंतिम-उपयोग तिथि दिखाता है।
Keys बनाने, संपादित करने और रिवोक करने के लिए सही वर्कस्पेस भूमिका चाहिए: Admins और Developers के पास यह होती है। Users, teams & roles देखें।
Key बनाना
- API keys पेज पर, नई key बनाने का विकल्प चुनें।
- इसे इसके काम के अनुसार नाम दें, जैसे "Billing service production,", किसी व्यक्ति के नाम पर नहीं।
- स्कोप चुनें। हर स्कोप में read या write लेवल होता है। केवल वही स्कोप और लेवल दें जो एप्लिकेशन को चाहिए।
- Key बनाएँ और सीक्रेट तुरंत कॉपी करें।
सीक्रेट केवल एक बार दिखाया जाता है
पूरी key केवल एक बार दिखती है, जब आप key बनाते या रोटेट करते हैं। Bird सीक्रेट दोबारा नहीं दिखा सकता। इसे सीधे किसी सीक्रेट मैनेजर या डिप्लॉयमेंट कॉन्फ़िगरेशन में कॉपी करें। अगर आप इसे खो दें, तो key को रोटेट या रिप्लेस करें।
API keys पेज पर key की पंक्ति से उसके स्कोप संपादित करें। संपादन अनुमति सेट को बदल देता है और सीक्रेट वही रहता है। किसी पुरानी key में अनुमति जोड़ने के लिए आपको उसे रोटेट करना पड़ सकता है। स्कोप प्रतिबंधों के लिए Authentication & API keys देखें।
Key रिवोक करना
जब key की ज़रूरत न रहे या आपको लगे कि वह लीक हो गई है, तो उसे रिवोक करें। रिवोकेशन स्थायी है। Key वैलिडेशन एक शॉर्ट-लिव्ड कैश का उपयोग करता है, इसलिए रिवोक की गई key अधिकतम पाँच सेकंड तक काम कर सकती है, उसके बाद अनुरोध प्रमाणीकरण में विफल हो जाते हैं।
अगर आपको लगता है कि कोई key लीक हो गई है, तो उसे रिवोक करें और रिप्लेसमेंट डिप्लॉय करें। जब तक एप्लिकेशन एक सक्रिय key का उपयोग नहीं करता, अनुरोध विफल रहेंगे।
बिना डाउनटाइम के रोटेट करने के लिए, रोटेशन एक्शन का उपयोग करें और इसकी डिफ़ॉल्ट 24 घंटे की ग्रेस अवधि रखें। ग्रेस अवधि समाप्त होने से पहले रिप्लेसमेंट डिप्लॉय करें। छोटी ग्रेस अवधि तभी सेट करें जब आप कॉलर्स को जल्दी अपडेट कर सकें।
सब कुछ रिकॉर्ड होता है
Key निर्माण, स्कोप संपादन, रोटेशन और रिवोकेशन आपके संगठन की ऑडिट लॉग में दिखाई देते हैं। स्कोप संपादन में जोड़े और हटाए गए स्कोप रिकॉर्ड होते हैं। उनके मेटाडेटा की समीक्षा करने के लिए key सूची में रिवोक की गई keys शामिल करें।
अच्छी आदतें
- हर एप्लिकेशन और एनवायरनमेंट के लिए एक अलग key रखें। स्टेजिंग और प्रोडक्शन keys अलग रखें ताकि आप एक को रिवोक करें तो दूसरी प्रभावित न हो।
- अंतिम-उपयोग कॉलम पर नज़र रखें। जिन निष्क्रिय keys की अब ज़रूरत नहीं है, उन्हें रिवोक करें।
- Keys को कभी भी क्लाइंट-साइड कोड या पब्लिक रिपॉज़िटरी में न रखें। Keys केवल सर्वर-साइड कॉन्फ़िगरेशन और सीक्रेट मैनेजर में होनी चाहिए।
अगले कदम
- Authentication & API keys: key संरचना, स्कोप विवरण, और API कॉन्ट्रैक्ट
- ऑडिट लॉग: key निर्माण और रिवोकेशन इवेंट की समीक्षा
- Users, teams & roles: keys कौन प्रबंधित कर सकता है
संबंधित संसाधन
इस विषय के लिए डॉक्यूमेंटेशन, गाइड और उदाहरणों के साथ आगे बढ़ें। संसाधन अंग्रेज़ी में हैं।