नॉलेज बेस
API कुंजियाँ
हर काम के लिए एक कुंजी, सिर्फ़ ज़रूरी स्कोप और भेजने वालों तक सीमित, और हर कॉल दर्ज।
विवरण
- सेटिंग्स → API कुंजियाँ में, अपने किसी वर्कस्पेस पर बनाई जाती हैं। सीक्रेट एक ही बार दिखाया जाता है, और हर कुंजी oe_live_ कुंजी होती है।
- कुंजी में सिर्फ़ आपके चुने स्कोप होते हैं, और नई कुंजी emails:send से शुरू होती है। उसमें एक भूमिका भी हो सकती है, जो दूसरी अनुमति नहीं बल्कि छत है: GET /ping वे स्कोप लौटाता है जो कुंजी बताती है और वे जो भूमिका ने उसे छोड़े, इसलिए ऐसे स्कोप पर 403 का, जो कुंजी के पास साफ़ है, कारण दिखता है।
- भेजने का दायरा 25 पूरे डोमेन और 50 अलग पतों तक होता है। पूरा डोमेन बाद में जोड़े गए पते भी कवर करता है, और सूची से बाहर का भेजने वाला 403 से अस्वीकार होता है।
- एक वैकल्पिक समाप्ति कुंजी को अपने आप खत्म होने देती है, दस साल आगे तक।
- बदलना सिर्फ़ सीक्रेट बदलता है: id, स्कोप, भेजने का दायरा और अनुरोध इतिहास बने रहते हैं, और नया बनते ही पुराना सीक्रेट काम करना बंद कर देता है। keys:write वाली कुंजी API से खुद को बदल सकती है। रद्द करना अपडेट है, हटाना नहीं, इसलिए बाद की कॉल को revoked_api_key बताया जाता है।
- हर प्रमाणित कॉल उसके मेथड, पाथ, स्थिति, त्रुटि कोड, अवधि, IP और यूज़र एजेंट के साथ दर्ज होती है, बॉडी या क्वेरी स्ट्रिंग कभी नहीं। कुंजी का पेज इसे एनालिटिक्स, गतिविधि और अनुरोध के रूप में दिखाता है, सबसे व्यस्त रूट, वे कितनी बार विफल होते हैं और उनकी माध्य लेटेंसी के साथ, और यही व्यू एक साथ कई कुंजियों को कवर करते हैं। लॉग रखा जाता है, छाँटा नहीं जाता।
- पेज जो कुछ करता है वह API और SDK में भी है: GET /keys और GET /keys/{id} कुंजियों को उनके सीक्रेट के बिना पढ़ते हैं, POST /keys एक बनाता है, PATCH /keys/{id} उसका नाम बदलता है, उसके स्कोप या भेजने का दायरा बदलता है और उसे बंद और फिर चालू करता है, और rotate, revoke और delete वही करते हैं जो वे कहते हैं। अनुरोध लॉग और गतिविधि भी इसी तरह पढ़े जाते हैं, एक कुंजी के लिए या सबके लिए, पेज के फ़िल्टरों के साथ। पढ़ने के लिए keys:read चाहिए और हर बदलाव के लिए keys:manage, दो स्कोप जो किसी कुंजी के पास तब तक नहीं होते जब तक कोई उसे न दे। MCP सर्वर भी लॉग और गतिविधि पढ़ता है, listApiKeyRequests और listApiKeyActivity के रूप में।
- कोई कुंजी कभी खुद से ज़्यादा व्यापक कुंजी नहीं बनाती और न उस तक पहुँचती है: उसके स्कोप, भूमिका, समाप्ति, मोड और भेजने का दायरा, सब कॉल करने वाली कुंजी के भीतर ही रहने चाहिए। दोबारा सत्यापन किसी कुंजी से की गई कॉल पर लागू नहीं हो सकता, इसलिए keys:manage ऐसा क्रेडेंशियल है जो क्रेडेंशियल बनाता है। इसे सिर्फ़ उस ऑटोमेशन को दें जो कुंजियाँ जारी करता है, उसकी अपनी भूमिका, भेजने के दायरे और समाप्ति के साथ, और गतिविधि टैब पर नज़र रखें, जहाँ वह जो कुछ करता है उसी के नाम दर्ज होता है।
- क्या नहीं है: कुंजी को IP पतों से बाँधा नहीं जा सकता, और टेस्ट-मोड कुंजी नहीं बनाई जा सकती।