API कुंजियाँ
इस पेज पर
API कुंजियाँ आपके अपने सॉफ़्टवेयर को — या BYOK (Bring Your Own Key) का समर्थन करने वाले किसी भी थर्ड-पार्टी सिस्टम को — Performance Hub द्वारा प्रकाशित मॉडल का उपयोग करने देती हैं। कुंजियाँ Settings (कॉग) → Service Access & API Keys में प्रबंधित की जाती हैं। इन्हें प्रबंधित करने के लिए आपका Organisation Administrator होना ज़रूरी है।
"API कुंजियाँ प्रोविज़न करें, ताकि BYOK (Bring Your Own Key) का समर्थन करने वाले थर्ड-पार्टी सॉफ़्टवेयर और सिस्टम Performance Hub द्वारा प्रकाशित मॉडल से कनेक्ट हो सकें।"
चित्र 1: API कुंजियों की सूची: लेबल, छिपाई गई कुंजी, स्थिति, खर्च और सीमाएँ, मॉडल, अंतिम उपयोग और पंक्ति की कार्रवाइयाँ
कुंजियों की सूची
| कॉलम | अर्थ |
|---|---|
| Label | वह वैकल्पिक नाम जो आपने कुंजी को दिया है। |
| Key | छिपाई गई कुंजी (जैसे phk_7Qm2…Xa9LkP) — बनाने के बाद पूरा सीक्रेट फिर कभी नहीं दिखाया जाता। |
| Status | Active, Provisioning… (थोड़ी देर के लिए, जब नई कुंजी सेट हो रही होती है), या Disabled (रद्द; पंक्ति धुंधली दिखती है)। |
| Spend / limits | आजीवन खर्च, और कुंजी पर सेट की गई किसी भी खर्च सीमा की ओर प्रगति। |
| Models | all, या उन मॉडलों की संख्या जिन तक कुंजी सीमित है। |
| Last used | कुंजी ने आखिरी बार कब अनुरोध किया। |
| Actions | Edit, Rotate, Revoke (या Re-activate), Delete। |
अगर आप Workflows का उपयोग करते हैं, तो एक Workflows पंक्ति छिपाई गई कुंजी की जगह Managed service दिखाती है। कोई भी कुंजी न होने पर सूची में "No API keys yet." दिखता है।
कुंजी बनाना
Create key पर क्लिक करें। Create API key ड्रॉअर खुलता है:
चित्र 2: Create API key ड्रॉअर: लेबल, कनेक्शन का प्रकार, खर्च सीमाएँ, रेट सीमाएँ, मॉडल प्रतिबंध और गार्डरेल ओवरराइड
| सेटिंग | व्यवहार |
|---|---|
| Label (optional) | कुंजी का नाम, आमतौर पर उस सिस्टम का जिसके लिए यह है (उदाहरण के लिए Hotel Concierge App, Clinic Intake Assistant या Booking Website)। इसकी पुरज़ोर सलाह दी जाती है — Activity और Logs में उपयोग का श्रेय लेबल से ही दिया जाता है। |
| Connection type | API key — "सामान्य API कुंजियाँ API Keys सूची में रहती हैं।" External agent — "बाहरी एजेंट Connected Services के अंतर्गत दिखते हैं और प्रमाणीकरण के लिए इस कुंजी का उपयोग करते हैं।" यह कुंजी बनाते समय सेट होता है; इसे बाद में बदला नहीं जा सकता। |
| Set spend limits for this key | "इस कुंजी के लिए दैनिक, मासिक और आजीवन सीमाओं का कोई भी संयोजन सेट करें।" — Daily limit ("हर दिन की शुरुआत में रीसेट होती है (सुविधा का टाइमज़ोन)।"), Monthly limit ("हर महीने की 1 तारीख को रीसेट होती है (सुविधा का टाइमज़ोन)।"), और Lifetime cap ("इस कुंजी के पूरे जीवनकाल का कुल खर्च। कभी रीसेट नहीं होती।")। |
| Rate limits (optional) | "इस कुंजी के लिए प्रति मिनट अनुरोधों और टोकन की सीमा तय करें। असीमित के लिए खाली छोड़ें।" — Requests / min और Tokens / min। |
| Restrict models for this key | "इस कुंजी से केवल चुने गए मॉडल का उपयोग किया जा सकेगा।" सुविधा के सक्षम मॉडलों में से चुनें। |
| Override facility guardrails for this key | "इस कुंजी के लिए गार्डरेल को स्पष्ट रूप से बंद करने के लिए कोई भी न चुनें।" चालू होने पर, यह कुंजी सुविधा के गार्डरेल के बजाय अपने गार्डरेल चयन का उपयोग करती है — "none" सहित। गार्डरेल देखें। |
Create key पर क्लिक करें।
एक बार दिखने वाला सीक्रेट
नई कुंजी Copy your API key डायलॉग में केवल एक बार दिखाई जाती है:
चित्र 3: नई कुंजी केवल एक बार दिखाई जाती है: डायलॉग बंद करने से पहले उसे कॉपी कर लें
"पूरी कुंजी केवल इसी समय दिखाई जाती है। इसे किसी सुरक्षित जगह पर रखें।"
Done पर क्लिक करने से पहले इसे अपने सीक्रेट मैनेजर में कॉपी कर लें। यह डायलॉग बंद होने के बाद, केवल छिपाया गया रूप ही दिखाया जाता है। अगर सीक्रेट खो जाए, तो नया सीक्रेट पाने के लिए कुंजी को Rotate करें।
कुंजी संपादित करना
Configure API key ड्रॉअर खोलने के लिए किसी कुंजी की पंक्ति (या उसकी Edit पेंसिल) पर क्लिक करें — इसमें बनाते समय वाली ही सेटिंग्स होती हैं (लेबल, खर्च सीमाएँ, रेट सीमाएँ, मॉडल प्रतिबंध, गार्डरेल ओवरराइड):
चित्र 4: Configure API key ड्रॉअर
बदलाव सहेजने के कुछ ही क्षणों में लागू हो जाते हैं। जब किसी कुंजी पर दैनिक/मासिक सीमाएँ हों, तो उसकी पंक्ति उनके मुकाबले उपयोग (Today, This month, Lifetime) दिखाती है, और किसी सीमा तक पहुँचने पर Limit reached बैज दिखता है।
कुंजी का जीवनचक्र: रोटेट, रद्द, हटाना
हर कार्रवाई के लिए एक पुष्टि डायलॉग होता है, जो ठीक-ठीक बताता है कि क्या होगा:
| कार्रवाई | प्रभाव | पुष्टि का टेक्स्ट |
|---|---|---|
| Rotate | उन्हीं सेटिंग्स के साथ एक नया सीक्रेट जारी करता है (एक बार दिखाया जाता है); पुराना सीक्रेट तुरंत काम करना बंद कर देता है। | "एक नई कुंजी जारी की जाएगी और वर्तमान कुंजी तुरंत काम करना बंद कर देगी।" "पुरानी कुंजी का अब भी उपयोग करने वाली सभी सेवाओं को आपको फिर से कॉन्फ़िगर करना होगा। इसे पूर्ववत नहीं किया जा सकता।" |
| Revoke | कुंजी को तुरंत, पूर्ववत किए जा सकने वाले तरीके से, अक्षम करता है। | "यह कुंजी तुरंत अक्षम हो जाएगी और इसका उपयोग करने वाली सभी सेवाएँ काम करना बंद कर देंगी। आप इसे बाद में फिर से सक्रिय कर सकते हैं।" |
| Re-activate | रद्द की गई कुंजी को बहाल करता है (वही सीक्रेट)। | कोई नहीं — तुरंत चलता है। |
| Delete | कुंजी को स्थायी रूप से हटाता है। | "इससे कुंजी स्थायी रूप से हट जाती है और इसका उपयोग करने वाली सभी सेवाएँ काम करना बंद कर देंगी। इसे पूर्ववत नहीं किया जा सकता।" |
चित्र 5: Delete API key की पुष्टि
किसका उपयोग करें: लीक होने का संदेह होने पर रोटेट करें (सेवा अपनी सेटिंग्स और इतिहास बनाए रखती है — बस सीक्रेट अपडेट करें); किसी सिस्टम को अस्थायी रूप से रोकने के लिए रद्द करें; केवल तभी हटाएँ जब इंटीग्रेशन हमेशा के लिए खत्म हो गया हो।
कुंजी से कनेक्ट करना
कुंजियों की सूची के नीचे Connecting to the API कार्ड आपके परिवेश के लिए बेस URL और कॉपी-पेस्ट करने योग्य एक उदाहरण अनुरोध दिखाता है। SDK उदाहरणों और त्रुटि प्रबंधन के साथ पूरी क्विकस्टार्ट गाइड के लिए अपना एप्लिकेशन कनेक्ट करना देखें।