डेवलपर API कुंजियां

सेटिंग्स, सेक्शन डेवलपर API कुंजियां (/app/settings#developer)। केवल मालिक और एडमिन। कुंजी से आपका अपना सॉफ़्टवेयर OmniBrand के सार्वजनिक API को इस हेडर के साथ कॉल कर सकता है: Authorization: Bearer ob_live_…

चरण दर चरण: कुंजी बनाएं

1. कुंजी का नाम (उदाहरण के लिए CI बॉट) में 60 वर्णों तक एक नाम टाइप करें, ताकि आप बाद में जान सकें कि इसका उपयोग क्या करता है। केवल रिक्त स्थान का नाम स्वीकार नहीं किया जाता है: बॉक्स कहता है "कुंजी को एक नाम दें, उदाहरण के लिए "वेबसाइट सिंक"। और कुछ भी नहीं बनाया जाता है। नाम से पहले और बाद के स्थान हटा दिए जाते हैं।
2. कुंजी के दायरे में, केवल पढ़ना (डेटा पढ़ना) या पढ़ना + लिखना (चीजें बनाना और बदलना भी) चुनें।
3. कुंजी बनाएं पर क्लिक करें।
4. एक पीला बॉक्स ""(नाम)" के लिए नई कुंजी दिखाता है। इसे अभी कॉपी करें: यह केवल एक बार दिखाया गया है। और पूरी कुंजी, कॉपी करें के साथ (यह तब कॉपी किया गया कहती है) और मैंने इसे सहेज लिया है, जो बॉक्स को बंद कर देती है। कुंजी को अभी कॉपी करें और इसे कहीं सुरक्षित रखें; ओमनीब्रांड केवल एक फिंगरप्रिंट संग्रहीत करता है और इसे फिर कभी नहीं दिखा सकता है।

सूची

हर कुंजी पर उसका नाम, शुरुआती अक्षर (ob_live_…), उसका दायरा, आखिरी बार कब उपयोग हुई ("उपयोग ..." या "कभी उपयोग नहीं हुई") और उसकी समाप्ति तिथि के साथ "समाप्ति ..." दिखता है।

• रोटेट करें: पहले पूछता है: "घुमाएँ "(नाम)" (प्रीफ़िक्स…)? आपको एक ही बार में एक नई कुंजी मिलती है। वर्तमान कुंजी 24 घंटे तक काम करती रहती है और फिर बंद हो जाती है, इसलिए नई कुंजी को हर जगह रखें जहां पुराने का उपयोग किया जाता है।" आगे बढ़ने के लिए कुंजी रोटेट करें पर क्लिक करें, या रद्द करें। उसी नाम और स्कोप वाली नई कुंजी उसी पीले बॉक्स में एक बार दिखाई जाती है। पुरानी कुंजी 24 घंटे तक काम करती रहती है ताकि आप अपना इंटीग्रेशन नई कुंजी पर ले जा सकें, फिर बंद हो जाती है। तब तक वह सूची में बनी रहती है, बिना कटे, "पुरानी कुंजी [तारीख और समय] तक काम करती है" और रद्द करें बटन के साथ।
• रद्द करें: पूछता है "कुंजी (name) (prefix…) रद्द करें? इसका इस्तेमाल करने वाली हर चीज़ तुरंत काम करना बंद कर देती है, और रद्द की गई कुंजी फिर से चालू नहीं की जा सकती।" विंडो का शीर्षक कुंजी रद्द करें? होता है; कुंजी को तुरंत रोकने के लिए कुंजी रद्द करें पर क्लिक करें, या उसे रखने के लिए रद्द करें। यह रोटेशन के बाद 24 घंटों के दौरान पुरानी कुंजी पर भी काम करता है: अगर आपने इसलिए रोटेट किया क्योंकि कुंजी लीक हो गई थी, तो पुरानी कुंजी पर रद्द करें पर क्लिक करें ताकि वह अभी रुक जाए। रद्द की गई कुंजियां (और 24 घंटे पूरे होने के बाद रोटेट की गई कुंजियां) सूची में बनी रहती हैं, कटी हुई, नाम के नीचे लाल "(date) को रद्द की गई" लेबल के साथ।

कुंजी किसकी होती है

• कुंजी उस व्यक्ति की होती है जिसने उसे बनाया, और यह उन वर्कस्पेस पर लागू होती है जहाँ वह व्यक्ति बनाते समय मालिक या एडमिन था।
• यह तभी तक काम करती है जब तक उसे बनाने वाला उन सभी वर्कस्पेस का सक्रिय मालिक या एडमिन है जिन पर यह लागू है। अगर उसे हटाया जाए, उसकी भूमिका घटाई जाए या उसका लॉगिन बंद कर दिया जाए, तो कॉल इस संदेश के साथ विफल होती हैं: "जिस व्यक्ति ने यह API कुंजी बनाई थी, वह अब इसके वर्कस्पेस का एडमिन नहीं है। किसी मौजूदा एडमिन से नई कुंजी बनाने को कहें।"
• आप केवल वही कुंजियाँ देख, रोटेट और रद्द कर सकते हैं जिनके वर्कस्पेस के आप खुद एडमिन हैं। कई क्लाइंट वर्कस्पेस वाले खाते में एक क्लाइंट का एडमिन दूसरे क्लाइंट की कुंजियाँ नहीं देख सकता।

अगर कुछ गलत हो जाए

• "यह API कुंजी समाप्त हो गई है। इसे सेटिंग्स > डेवलपर API कुंजियाँ में रोटेट करें।": कुंजियाँ एक साल चलती हैं। डेवलपर API कुंजियां में उस पर रोटेट करें क्लिक करें (या नई कुंजी बनाएं) और अपना इंटीग्रेशन अपडेट करें।
• "अमान्य या रद्द की गई API कुंजी": कुंजी रद्द कर दी गई थी, रोटेट करने के बाद की 24 घंटे की छूट अवधि खत्म हो गई, या इसे अधूरा कॉपी किया गया।
• कोई API कुंजी दूसरी कुंजियाँ बना, रोटेट या रद्द नहीं कर सकती; यह केवल साइन इन किया हुआ व्यक्ति कर सकता है।
• "This endpoint is not available to API keys" (यह एंडपॉइंट API कुंजियों के लिए उपलब्ध नहीं है): वह कॉल केवल साइन-इन किए हुए व्यक्ति के लिए है, कुंजी का स्कोप चाहे जो हो। कोई कुंजी कभी इन तक नहीं पहुंच सकती: सदस्य और आमंत्रण (/workspaces/{id}/members, /workspaces/{id}/invitations, /invitations), वर्कस्पेस बनाना, उसका नाम बदलना, संग्रहीत करना, संग्रह से निकालना या हटाना, आउटबाउंड वेबहुक (/workspaces/{id}/webhooks), एक्सपोर्ट, अनुमोदन चेन, रिपोर्ट शेड्यूल, किसी चैनल को कनेक्ट, डिस्कनेक्ट या हटाना या उसका मालिक बदलना, संगठन का लोगो, प्रोफ़ाइल और ऑनबोर्डिंग, और /auth, /billing, /admin या /tenant/api-keys के अंतर्गत कुछ भी। ये काम ऐप में, मालिक या एडमिन के रूप में लॉग इन करके करें।

संबंधित

• भूमिकाएँ और अनुमतियाँ
• सेटिंग्स पेज