कुंजी बनाएँ
- सेटिंग्स, फिर API कुंजियाँ खोलें, और कुंजी बनाएँ चुनें।
- इसका नाम उस सिस्टम के अनुसार रखें जो इसका उपयोग करेगा। एक दायरा और वैकल्पिक समाप्ति तिथि चुनें।
- कुंजी अभी कॉपी करें और अपने सिस्टम के गोपनीय भंडार में रखें।
Important: पूरी कुंजी केवल एक बार दिखाई जाती है। यदि यह खो जाए, तो इसे रद्द करें और नई कुंजी बनाएँ।
| दायरा | किस रूप में काम करती है |
|---|---|
| केवल पढ़ें | एक दर्शक। यह वही पढ़ सकती है जो एक दर्शक पढ़ सकता है। |
| पढ़ें और लिखें | अधिकतम एक प्रबंधक। यह वही बना और बदल सकती है जो एक प्रबंधक कर सकता है। |
इसका उपयोग करें
ऐप के API को भेजे जाने वाले हर अनुरोध के Authorization हेडर में कुंजी भेजें:
Authorization: Bearer ehk_...
- कुंजी केवल अपने ही संगठन के लिए और केवल अपने दायरे के साथ काम करती है।
- कुंजी के साथ CSRF हेडर की आवश्यकता नहीं होती।
- कोई कुंजी अन्य कुंजियाँ बना या प्रबंधित नहीं कर सकती।
- कुंजी से किए गए अनुरोध ऑडिट लॉग में API कुंजी के नाम से दर्ज होते हैं।
रद्द करें
किसी कुंजी पर रद्द करें चुनें और वह तुरंत काम करना बंद कर देती है, इसलिए उसका उपयोग करने वाले सिस्टम को 401 त्रुटियाँ मिलती हैं। जिस सदस्य ने कुंजी बनाई थी, उसके संगठन छोड़ने पर भी कुंजी काम करना बंद कर देती है। सूची दिखाती है कि हर कुंजी आख़िरी बार कब उपयोग हुई।
Tip: जहाँ संभव हो, हर इंटीग्रेशन को उसकी अपनी केवल-पढ़ने वाली कुंजी दें। यदि कोई कुंजी लीक हो जाए, तो आप केवल उसी को रद्द करते हैं।
अपने डेवलपर्स के लिए API का विवरण पाने के लिए संपर्क फ़ॉर्म के माध्यम से अनुरोध करें।