स्कोप वाली API कुंजियाँ - सीमित KYC API एक्सेस

प्रत्येक एप्लिकेशन की शुरुआत एक प्राइमरी सीक्रेट के साथ होती है जिसके पास एप्लिकेशन द्वारा किए जा सकने वाले सभी कार्यों का पूर्ण एक्सेस होता है। आप इसके साथ नामित API कुंजियाँ जोड़ सकते हैं, प्रति सेवा या पार्टनर एक, जिनमें से प्रत्येक के पास केवल वही एक्सेस होता है जिसकी उसे आवश्यकता होती है। अपने पेआउट प्रदाता को एक ऐसी कुंजी दें जो किसी एक वर्कफ़्लो के स्वीकृत सत्रों को पढ़ सके और कुछ भी बदल न सके, अपने बैकएंड के लिए एक अलग कुंजी रखें, और दूसरे को प्रभावित किए बिना किसी भी एक को रिवोक कर दें।

---

​

इन्हें कहाँ खोजें

बिजनेस कंसोल में, अपना एप्लिकेशन चुनें और Developers -> API keys खोलें। यह सूची एप्लिकेशन की प्रत्येक कुंजी को उसकी स्थिति, पिछले 30 दिनों में उसके अनुरोधों, इसे किसने बनाया, इसके एक्सेस और इसे पिछली बार कब उपयोग किया गया था, इसके साथ दिखाती है। दाईं ओर इसका पूर्वावलोकन करने के लिए किसी कुंजी पर क्लिक करें, या उपयोग, एक्सेस, हाल के अनुरोधों, एक क्विकस्टार्ट स्निपेट और इसकी गतिविधि के लिए इसका पूरा पेज खोलें। कुंजियाँ किसी एक एप्लिकेशन से संबंधित होती हैं और केवल उसी के लिए काम करती हैं। कुंजी का एनवायरनमेंट एप्लिकेशन का ही एनवायरनमेंट होता है: सैंडबॉक्स एप्लिकेशन की कुंजियाँ कभी भी बिल किए गए सत्यापन नहीं बनाती हैं।

---

​

रीडायरेक्ट URL और अनुमत डोमेन

आपके द्वारा चुने गए एप्लिकेशन और एनवायरनमेंट के लिए दो सूचियाँ सेट करने हेतु Developers > API keys > Redirects and domains खोलें। जब अनुमत डोमेन सूची में प्रविष्टियाँ होती हैं, तो Create session ऐसे callback को 400 एरर के साथ अस्वीकार कर देता है जो उनमें से किसी एक पर नहीं होता है। खाली सूची का अर्थ है कोई प्रतिबंध नहीं। सर्वर-टू-सर्वर कॉल प्रभावित नहीं होती हैं।

---

​

कुंजी बनाएं

​

प्रीसेट

​

संसाधन

पढ़ना किसी संसाधन पर GET अनुरोधों को कवर करता है; लिखना POST, PUT, PATCH और DELETE को भी कवर करता है। कस्टम एक्सेस वाली कुंजी सार्वजनिक API पर काम करती है: सत्र, उपयोगकर्ता, व्यवसाय, लेन-देन, वर्कफ़्लो और webhook endpoints, और स्टैंडअलोन जांच। केवल Business Console द्वारा उपयोग किए जाने वाले endpoint के लिए इसे 403 उत्तर मिलता है; उन्हें पूर्ण-एक्सेस वाली कुंजी की आवश्यकता होती है। मीडिया पढ़ने की अनुमति के बिना कुंजी प्रत्येक छवि, वीडियो और PDF URL को null पर सेट करके सत्र निर्णय प्राप्त करती है, और PDF रिपोर्ट endpoints 403 उत्तर देते हैं। सत्र लिखने की अनुमति के बिना कुंजी कभी भी सत्र का सत्यापन लिंक या सत्र token प्राप्त नहीं करती है, क्योंकि जो कोई भी उन्हें रखता है वह अंतिम उपयोगकर्ता के रूप में सत्यापन पूरा कर सकता है: वे फ़ील्ड null के रूप में वापस आते हैं। उसी कारण से, send_verification_link: true के साथ किसी व्यक्ति को बनाने के लिए लोग लिखने के अलावा सत्र लिखने की भी आवश्यकता होती है, क्योंकि यह एक सत्र बनाता है और उसका लिंक ईमेल करता है। इसके बिना, कॉल 403 उत्तर देती है और कुछ भी नहीं बनाती है।

​

सीमाएं

कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित कुंजी सत्र endpoints पर काम करती है, जहाँ सीमा लागू की जा सकती है। इसकी पहुंच लोगों, कंपनियों, लेन-देन या एनालिटिक्स तक नहीं हो सकती है, और यह स्टैंडअलोन जांच नहीं चला सकती है।

---

​

सीमित-अधिकार वाली कुंजी को API कैसे उत्तर देती है

सत्र सूचियां केवल वही सत्र लौटाती हैं जिन्हें कुंजी की सीमाएं अनुमति देती हैं।

---

​

एक्सेस संपादित करें

किसी कुंजी का मेनू, उसका पूर्वावलोकन या उसका पेज खोलें और एक्सेस संपादित करें चुनें। प्रीसेट, संसाधन, सीमाएं या समाप्ति बदलें, फिर केवल बदले हुए हिस्सों की समीक्षा करें, पहले और बाद में। सीक्रेट वही रहता है, इसलिए कुछ भी दोबारा डिप्लॉय करने की आवश्यकता नहीं होती है, और नया एक्सेस एक मिनट के भीतर लागू हो जाता है। प्राथमिक सीक्रेट के पास हमेशा पूर्ण एक्सेस होता है और इसे संपादित नहीं किया जा सकता है।

---

​

कुंजी रोटेट करें

रोटेट करने से कुंजी का सीक्रेट बदल जाता है। नया सीक्रेट एक बार दिखाया जाता है, और वर्तमान सीक्रेट 24 घंटे तक काम करता रहता है ताकि आप बिना किसी डाउनटाइम के नया सीक्रेट डिप्लॉय कर सकें। उसके बाद, पुराने सीक्रेट के साथ किया गया प्रत्येक अनुरोध 401 उत्तर देता है। प्राथमिक सीक्रेट को उसी तरह, समान 24 घंटे के ओवरलैप के साथ रोटेट किया जाता है।

---

​

कुंजी निरस्त करें

निरस्त करने से कुंजी तुरंत काम करना बंद कर देती है: इसके साथ किया गया प्रत्येक अनुरोध 401 उत्तर देता है। इसे पूर्ववत नहीं किया जा सकता। प्राथमिक सीक्रेट को निरस्त नहीं किया जा सकता; इसके बजाय इसे रोटेट करें।

---

​

उपयोग और ऑडिट ट्रेल

प्रत्येक कुंजी पिछले 30 दिनों के अपने अनुरोध, अपनी त्रुटि दर और विलंबता, तथा अपने नवीनतम अनुरोधों को उनके स्टेटस कोड के साथ दिखाती है, जिसमें वे अनुरोध भी शामिल हैं जिन्हें इसकी सीमाओं ने अस्वीकार कर दिया था। API कुंजी के साथ की गई प्रत्येक कॉल संगठन के ऑडिट लॉग में उस कुंजी के नाम के साथ दिखाई देती है जिसने इसे किया था।

---

​

कुंजियों का प्रबंधन कौन कर सकता है

API कुंजियों के प्रबंधन के लिए API कुंजियाँ की अनुमति आवश्यक है: उन्हें देखने के लिए पढ़ने की अनुमति, तथा उन्हें बनाने, संपादित करने, रोटेट करने और रिवोक करने के लिए लिखने की अनुमति। भूमिकाएँ और अनुमतियाँ देखें।