API कुंजियाँ
वह कुंजी बनाएँ जो आपकी वेबसाइट या सॉफ़्टवेयर को Measure Map Online से जोड़ती है, तय करें कि वह क्या कर सकती है, लाइव और परीक्षण का काम अलग रखें, और उसे सुरक्षित रूप से बदलें या सीमित करें।
API कुंजी आपकी अपनी वेबसाइट या सॉफ़्टवेयर को आपके Measure Map Online खाते के साथ काम करने देती है: अपनी साइट पर किसी प्रोजेक्ट का मानचित्र दिखाना, अपने विज़िटर के लिए प्रोजेक्ट शुरू करना, या REST API से प्रोजेक्ट पढ़ना और बदलना। आप कुंजियाँ डेवलपर पेज पर बनाते और प्रबंधित करते हैं।
डेवलपर पेज खोलें#
डैशबोर्ड मेनू में, उन्नत के नीचे, डेवलपर दबाएँ। यह API कुंजियाँ पर खुलता है, और इसके बाकी अनुभाग मेनू में इसके नीचे दिखते हैं (फ़ोन पर, पेज के ऊपर टैब के रूप में):
- अतिथि लिंक (Open Guest): आपकी वेबसाइट के लिए बिना कोड वाला लिंक। देखें Open Guest।
- API आज़माएँ, वेबहुक और REST API: देखें API संदर्भ।
- मानचित्र एम्बेड करें (Enterprise): देखें iFrame API।
कुंजी कार्ड के ऊपर का बैज बताता है कि आपकी कुंजी सक्रिय है, सक्रिय नहीं है (अभी कोई कुंजी नहीं), अक्षम है (API पहुँच निलंबित: कोई कुंजी काम नहीं करती और जब तक सहायता टीम निलंबन नहीं हटाती, नई कुंजी नहीं बनाई जा सकती) या समाप्त है (सदस्यता सक्रिय नहीं है)।
लाइव और सैंडबॉक्स#
कुंजी कार्ड के ऊपर, लाइव और सैंडबॉक्स के बीच बदलें। हर एक की अपनी कुंजी होती है, और पेज वही दिखाता है जो आप चुनते हैं। यह चुनाव API आज़माएँ पर भी लागू होता है, और अनुभागों के बीच आते-जाते समय बना रहता है। मानचित्र एम्बेड करें और अतिथि लिंक हमेशा आपकी लाइव कुंजी का उपयोग करते हैं, क्योंकि आपकी वेबसाइट के विज़िटर केवल लाइव प्रोजेक्ट खोल सकते हैं: इनमें से कोई भी खोलने पर पेज वापस लाइव पर आ जाता है।
- लाइव आपका असली खाता है, और पेज इसी पर खुलता है। अपनी वेबसाइट पर लाइव कुंजी का उपयोग करें।
- सैंडबॉक्स कोई एकीकरण बनाने और परखने के लिए है। सैंडबॉक्स कुंजी से बने प्रोजेक्ट, फ़ोल्डर और उत्पाद आपके असली प्रोजेक्ट, फ़ोल्डर और उत्पादों से अलग रखे जाते हैं: लाइव कुंजी उन्हें नहीं देख सकती, और सैंडबॉक्स कुंजी आपकी लाइव चीज़ें नहीं देख सकती। सैंडबॉक्स कुंजी से किए गए अनुरोध आपके उपयोग के आँकड़ों में नहीं गिने जाते, और ऐसी कुंजी से बने अतिथि प्रोजेक्ट का कभी बिल नहीं बनता।
नई सैंडबॉक्स कुंजी बनाने से आपकी लाइव कुंजी पर कभी कोई असर नहीं पड़ता, और इसका उल्टा भी सच है।
तय करें कि कुंजी क्या कर सकती है#
नई कुंजी की पहुँच में, हर पंक्ति API का एक क्षेत्र है। चुनें कि आप जो अगली कुंजी बनाएँगे, वह उसमें कितनी दूर तक पहुँच सके:
| क्षेत्र | विकल्प | यह क्या करने देता है |
|---|---|---|
| एम्बेड किए गए मानचित्र | कोई पहुँच नहीं, अनुमति है | एम्बेड किए गए मानचित्र में दर्शक को साइन इन कराएँ। अधिकांश एकीकरणों को केवल यही चाहिए। |
| प्रोजेक्ट्स | कोई पहुँच नहीं, पढ़ना, पढ़ना और बदलना | प्रोजेक्ट और फ़ोल्डर, उनके माप, टिप्पणियों और निर्यात के साथ। |
| उपयोगकर्ता (Enterprise) | कोई पहुँच नहीं, पढ़ना, पढ़ना और बदलना | आपके खाते के लोग और उनकी सीटें। |
| उत्पाद | कोई पहुँच नहीं, पढ़ना, पढ़ना और बदलना | आपकी उत्पाद सूची और उनकी कीमतें। |
कोई विकल्प ठीक-ठीक क्या देता है, यह देखने के लिए उस पर पॉइंटर रखें। आपकी पहली कुंजी केवल एम्बेड किए गए मानचित्र से शुरू होती है, जो किसी एम्बेड किए गए मानचित्र के लिए काफ़ी है; किसी दूसरी कुंजी की जगह लेने वाली कुंजी उसी कुंजी की पहुँच से शुरू होती है। कम से कम एक क्षेत्र चुनें। API से अपने संगठन के किसी सदस्य के रूप में साइन इन करने के लिए उपयोगकर्ता: पढ़ना और बदलना चाहिए, एम्बेड किए गए मानचित्र नहीं।
कुंजी क्या कर सकती है, यह उसे बनाते समय तय हो जाता है। किसी कुंजी को ज़्यादा या कम पहुँच देने के लिए नई कुंजी बनाएँ।
कुंजी बनाएँ#
- लाइव या सैंडबॉक्स चुनें।
- नई कुंजी की पहुँच में पहुँच तय करें।
- चाहें तो अपनी कुंजियों में फ़र्क करने के लिए नई कुंजी का नाम (वैकल्पिक) में एक नाम टाइप करें।
- नई कुंजी उत्पन्न करें दबाएँ।
कुंजी आपकी API कुंजी के नीचे दिखती है, शुरू और आख़िर के कुछ अक्षरों को छोड़कर छिपी हुई, एक पंक्ति के साथ जो बताती है कि वह क्या कर सकती है (अनुमतियाँ)। पूरी कुंजी देखने के लिए दबाएँ, या पूरी कुंजी कॉपी करने के लिए दबाएँ। आपके खाते पर हर बार कुंजी बनने पर आपको एक ईमेल मिलता है।
पहुँच के क्षेत्र आने से पहले बनी कुंजी उत्पादों के साथ काम करने और सदस्य के रूप में साइन इन करने को छोड़कर सब कुछ कर सकती है; कार्ड आपको इसकी चेतावनी देता है। अगर आप उसे केवल एम्बेड के लिए इस्तेमाल करते हैं, तो उसे सीमित पहुँच वाली कुंजी से बदलें।
कुंजी बदलें#
जब आपके पास पहले से कुंजी हो, तो फिर से नई कुंजी उत्पन्न करें दबाएँ। ऐप पहले आपको चेतावनी देता है: एक नई कुंजी बनाई जाएगी और आपकी मौजूदा कुंजी 24 घंटे तक काम करती रहेगी, ताकि आप उसका उपयोग करने वाली साइटें अपडेट कर सकें। काम पूरा होने पर आप उसे पहले भी रद्द कर सकते हैं।
पुरानी कुंजी पिछली कुंजियाँ में चली जाती है, उसके बचे हुए समय और उसके आख़िरी बार इस्तेमाल होने के समय के साथ। नई कुंजी लागू करते समय ये अब भी स्वीकार की जाती हैं। जैसे ही कोई इसका उपयोग न करे, इसे रद्द कर दें। उसे तुरंत बंद करने के लिए रद्द करें दबाएँ और पुष्टि करें; जो भी साइट अब भी उसका उपयोग कर रही है, वह तुरंत काम करना बंद कर देती है। कुंजी रद्द होने पर आपको एक ईमेल मिलता है।
आपके वेबसाइट प्रतिबंध नई कुंजी में कॉपी हो जाते हैं। आप लगभग एक मिनट में एक बार नई कुंजी बना सकते हैं।
कुंजी को अपनी वेबसाइटों तक सीमित करें#
केवल इस सूची की वेबसाइटें ब्राउज़र में आपकी कुंजी का उपयोग कर सकती हैं: किसी भी अन्य साइट के पेजों से एम्बेड किए गए मैप और अनुरोध अस्वीकार कर दिए जाते हैं। सर्वर से किए गए कॉल पर इसका कोई असर नहीं पड़ता।
- वेबसाइट प्रतिबंध में, एक वेबसाइट या डोमेन दर्ज करें
में अपनी साइट टाइप करें: कोई डोमेन जैसे
example.com, कोई IP पता याlocalhost। आप पूरा पता भी चिपका सकते हैं: केवल साइट का नाम सहेजा जाता है,https://, पाथ और पोर्ट के बिना। - जोड़ें दबाएँ।
किसी डोमेन में उसके सबडोमेन भी शामिल होते हैं: example.com
shop.example.com को अनुमति देता है। किसी साइट को हटाने के लिए
दबाएँ और पुष्टि करें; आख़िरी साइट हटाने के बाद कुंजी किसी
भी वेबसाइट से काम करती है। जब भी किसी कुंजी से कोई वेबसाइट हटाई जाती है, आपको
एक ईमेल मिलता है।
यह सूची ब्राउज़र पर लागू होती है। एम्बेड किया गया मानचित्र केवल सूची की किसी वेबसाइट के पेज पर खुलता है; अगर ब्राउज़र यह नहीं बताता कि वह किस पेज पर है, तो उसे अस्वीकार कर दिया जाता है। किसी वेब पेज से भेजा गया REST API अनुरोध सूची की किसी वेबसाइट से आना चाहिए। आपके अपने सर्वर से आया अनुरोध कोई वेबसाइट नहीं बताता और उसकी जाँच नहीं होती। Measure Map Online को हमेशा अनुमति रहती है, ताकि इस पेज के पूर्वावलोकन काम करते रहें।
देखें कि कुंजी का उपयोग कैसे हो रहा है#
उपयोग आपकी सभी लाइव कुंजियों को जोड़कर दिखाता है, इसलिए कुंजी बदलने पर भी आँकड़े जारी रहते हैं। यह पिछले 30 दिनों के अनुरोध दिखाता है, एम्बेड किए गए मानचित्रों और REST API दोनों के, हर दिन के लिए एक बार के साथ; और साथ में कुल योग, अंतिम पहुँच, मौजूदा कुंजी कब बनी (कुंजी बनाई गई), और शीर्ष डोमेन: वे वेबसाइटें जो आपकी कुंजियों का सबसे ज़्यादा उपयोग करती हैं। अगर वहाँ कोई ऐसी वेबसाइट दिखे जिसे आप नहीं पहचानते, तो कुंजी को सीमित करें या बदलें।
सैंडबॉक्स अनुरोध नहीं गिने जाते, इसलिए आँकड़े केवल लाइव पर दिखते हैं। यह पेज खुद API आज़माएँ और पूर्वावलोकनों में जो अनुरोध करता है, वे भी नहीं गिने जाते।
अपनी कुंजी सुरक्षित रखें#
- हर कुंजी को केवल उतनी पहुँच दें जितनी उसे चाहिए। किसी वेब पेज में रखी कुंजी (उदाहरण के लिए किसी एम्बेड के पते में) के पास केवल एम्बेड किए गए मानचित्र होना चाहिए।
- यह कुंजी आपका डेटा बदल सकती है। इसे अपने सर्वर पर रखें, किसी वेब पेज या ऐप में कभी नहीं।
- वेब पेजों में इस्तेमाल होने वाली कुंजी को अपनी वेबसाइटों तक सीमित रखें।
- अपनी स्क्रीन शेयर करते समय पेज पर कुंजी छिपी रहने दें; उसे कॉपी करने के लिए दिखाना ज़रूरी नहीं है।
- अगर कोई कुंजी लीक हो गई हो सकती है, तो नई कुंजी बनाएँ और पिछली कुंजियाँ में पुरानी कुंजी तुरंत रद्द करें।
- सैंडबॉक्स कुंजी से बनाएँ और परखें, ताकि प्रयोग कभी आपके असली प्रोजेक्ट के बीच न पहुँचें।
अब भी मदद चाहिए?
हमारी सहायता टीम को लिखें और बताएँ कि आप क्या करने की कोशिश कर रहे थे। स्क्रीनशॉट से मदद मिलती है।