API कुंजियाँ
हर काम के लिए एक कुंजी, उससे ज़्यादा कुछ नहीं।
हर सेवा को उसकी अपनी कुंजी दें, जिसमें सिर्फ़ ज़रूरी स्कोप और भेजने वाले हों। उसकी हर कॉल दर्ज होती है।
संक्षेप में
API कुंजी क्या है?
एक सीक्रेट जिसे आपका कोड हर अनुरोध के साथ भेजता है। यह बताता है कि कॉल किस वर्कस्पेस के लिए है और उसे क्या करने की अनुमति है।
32
स्कोप चुनने के लिए
25
पूरे डोमेन एक भेजने के दायरे में
3,650
दिन, सबसे लंबी वैधता
यह कैसे काम करता है
छत के रूप में भूमिका
एक भूमिका जोड़ें और कुंजी कभी उसकी अनुमति से ज़्यादा नहीं कर सकेगी। GET /ping दिखाता है कि कुंजी क्या माँगती है और भूमिका ने उसे क्या छोड़ा।
सीमित करें कि किसके नाम से भेजे
25 पूरे डोमेन और 50 अलग पते तक। इनसे बाहर का भेजने वाला 403 पाता है।
हर कॉल दर्ज
हर अनुरोध का मेथड, पाथ, स्थिति, त्रुटि और अवधि, सबसे व्यस्त रूट और वे कितनी बार विफल होते हैं।
देखें कि कुंजी क्या कर सकती है
GET /ping को किसी स्कोप की ज़रूरत नहीं और यह कुंजी की पहुँच बताता है।
{ "ok": true, "keyId": "4c1b257a66287fd113bd89d0", "mode": "live", "scopes": ["emails:send", "templates:write", "members:write"], "roleId": "role_2b81de079c1f0a4b7e05d386", "grantedScopes": ["emails:send", "templates:write"], "workspaceId": "10417196-e324-4283-af98-66ec62167c47"}आपको क्या मिलता है
आज प्रोडक्ट में
जगह पर बदलें
नया सीक्रेट, उसी id, स्कोप और इतिहास के साथ।
रद्द, हटाई नहीं
बाद की कॉल को revoked_api_key बताया जाता है।
वैधता अंतर्निहित
कुंजी की समाप्ति तय करें, दस साल आगे तक।
अच्छे तरीक़े
इसका पूरा फ़ायदा उठाएँ
- 01
हर सेवा के लिए एक कुंजी
तब लीक से एक इंटीग्रेशन प्रभावित होता है, सब नहीं।
- 02
कम से कम दें
emails:send से शुरू करें और ज़रूरत पड़ने पर स्कोप जोड़ें।
- 03
विफलताओं पर नज़र रखें
डिप्लॉय के बाद अनुरोध लॉग को विफल कॉल पर फ़िल्टर करें।
अभी की स्थिति
जानने लायक़
- IP अनुमति सूची नहीं
- कुंजी को अभी आपके सर्वरों के पतों से नहीं बाँधा जा सकता।
- टेस्ट कुंजियाँ नहीं
- सिर्फ़ oe_live_ कुंजियाँ बनाई जा सकती हैं, इसलिए हर भेजा असली है।
- API से लॉग नहीं
- अनुरोध लॉग ऐप में पढ़ा जाता है, किसी REST रूट से नहीं।
सवाल
अक्सर पूछे जाते हैं
आगे पढ़ें
इनके साथ अच्छा चलता है
शुरू करें
आपका डोमेन,
आपका मेल।
किसी डोमेन को OpenEmail की ओर पॉइंट करें और उसका मेल उसी के इर्द-गिर्द बने मेलबॉक्स में पढ़ें। मुफ़्त प्लान में एक डोमेन शामिल है।
