iFrame API
अपने किसी प्रोजेक्ट को अपनी वेबसाइट पर लाइव मानचित्र के रूप में दिखाएँ, उन इकाइयों, मानचित्र शैली और थीम में जो आपकी साइट के अनुकूल हों।
iFrame API किसी प्रोजेक्ट का मानचित्र आपके अपने वेब पेज पर लगाता है। विज़िटर आपके माप के साथ उपग्रह मानचित्र देखते हैं और उस पर घूम सकते हैं, बिना खाते के और आपकी साइट छोड़े बिना। प्रोजेक्ट, इकाइयाँ, मानचित्र शैली और रंग थीम आप चुनते हैं।
शुरू करने से पहले#
- एक लाइव API कुंजी, जिसके पास एम्बेड किए गए मानचित्र पहुँच हो। देखें API कुंजियाँ।
- एक प्रोजेक्ट जिसे विज़िटर देख सकें। उसका एक्सेस लेवल केवल देखने के लिए या सार्वजनिक रखें। निजी प्रोजेक्ट बिना खाते वाले विज़िटर के लिए नहीं खुलता। देखें कौन-से प्रोजेक्ट एम्बेड किए जा सकते हैं।
- चाहें तो कुंजी पर वेबसाइट प्रतिबंध, ताकि एम्बेड केवल आपकी अपनी साइटों पर काम करे। देखें API कुंजियाँ।
एम्बेड कोड बनाएँ#
डेवलपर > मानचित्र एम्बेड करें आपकी लाइव कुंजी से आपके लिए कोड बनाता है: प्रोजेक्ट, थीम, इकाइयाँ, मानचित्र प्रकार और आकार चुनें, लाइव पूर्वावलोकन जाँचें, और एम्बेड कोड कॉपी करें। अगर प्रोजेक्ट निजी है, तो अनुभाग यह बताता है और “केवल देखने के लिए” पर सेट करें देता है। हर चरण के लिए देखें एम्बेड कोड पाएँ।
कोड में आपकी कुंजी होती है, इसलिए वह तब तक काम करता है जब तक आप कुंजी नहीं बदलते। जब कुंजी एम्बेड किए गए मानचित्र से ज़्यादा कर सकती हो, तो यह अनुभाग आपको चेतावनी देता है, क्योंकि कोई भी उसे आपके पेज के सोर्स में पढ़ सकता है; और तब भी जब कुंजी पर कोई वेबसाइट प्रतिबंध न हो। केवल लाइव पूर्वावलोकन कम समय चलने वाले टोकन का उपयोग करता है। देखें कुंजी या टोकन।
एम्बेड का पता#
एम्बेड एक <iframe> है जिसका पता
https://app.measuremaponline.com/iframe_api से शुरू होता है, और उसके बाद ये
पैरामीटर आते हैं:
| पैरामीटर | ज़रूरत | मान |
|---|---|---|
pid |
ज़रूरी | प्रोजेक्ट की पहचान: ऐप में प्रोजेक्ट के पते में /p/ के बाद का हिस्सा। |
key |
key या token |
आपकी API कुंजी। |
token |
key या token |
आपके सर्वर से मिला टोकन (नीचे देखें)। |
ms |
वैकल्पिक | इकाइयाँ: metric या imperial। इसके बिना, संयुक्त राज्य अमेरिका के विज़िटर इंपीरियल इकाइयाँ देखते हैं और बाकी सभी मीट्रिक। |
maptype |
वैकल्पिक | satellite (डिफ़ॉल्ट), map, hybrid या terrain। |
theme |
वैकल्पिक | auto (डिफ़ॉल्ट: विज़िटर के अपने सिस्टम की सेटिंग का पालन करता है), light या dark। |
एक छोटा उदाहरण#
<iframe src="https://app.measuremaponline.com/iframe_api?pid=YOUR_PROJECT_ID&key=YOUR_API_KEY&maptype=satellite&theme=auto"
title="YOUR_PROJECT_NAME" width="500" height="500" style="border:0" allow="fullscreen"></iframe>
YOUR_PROJECT_ID, YOUR_API_KEY और YOUR_PROJECT_NAME बदलें (स्क्रीन रीडर
title पढ़कर सुनाते हैं), और चौड़ाई व ऊँचाई अपने पेज के अनुसार तय करें।
कुंजी या टोकन#
key के साथ, जैसा मानचित्र एम्बेड करें अनुभाग से मिले कोड में होता
है, एम्बेड तब तक काम करता है जब तक कुंजी काम करती है, उन वेबसाइटों पर जिनकी
उसके प्रतिबंध अनुमति देते हैं। तब आपकी कुंजी आपके पेज के सोर्स में दिखती है,
इसलिए:
- केवल एम्बेड किए गए मानचित्र पहुँच वाली कुंजी का उपयोग करें;
- उसे अपनी वेबसाइटों तक सीमित रखें;
- जब आप कुंजी बदलें, तो उन 24 घंटों के अंदर अपने पेज अपडेट करें जिनमें पुरानी कुंजी काम करती रहती है।
token के साथ, कुंजी आपके सर्वर पर रहती है। यह उन एम्बेड के लिए ठीक है
जिन्हें आपका अपना सर्वर हर विज़िट पर पेज में लिखता है: पेज दिखाने से पहले, वह
REST API से एक टोकन माँगता है और उसे iframe के पते में डालता है:
POST https://api.measuremaponline.com/api/v2/auth/iframe/token, जिसमें आपकी कुंजीAuthorizationहेडर में हो, एकtokenलौटाता है जो 60 मिनट तक काम करता है;POST https://api.measuremaponline.com/api/v2/auth/tokenयही करता है और सेकंड में एकdurationस्वीकार करता है, 24 घंटे तक। इसका जवाब बताता है कि टोकन कब समाप्त होगा।
आपका खाता एक घंटे में 600 तक टोकन ले सकता है। लाइव कुंजी का उपयोग करें: एम्बेड केवल लाइव प्रोजेक्ट दिखाते हैं, इसलिए सैंडबॉक्स कुंजी से बना टोकन कोई मानचित्र नहीं खोलता। देखें API संदर्भ।
विज़िटर क्या कर सकते हैं#
विज़िटर मानचित्र को खिसका और ज़ूम कर सकते हैं और आपकी आकृतियों के माप पढ़ सकते हैं। वे कुछ भी बदल नहीं सकते: एम्बेड के अंदर संपादन बंद रहता है, प्रोजेक्ट का एक्सेस लेवल चाहे जो हो। इसका एकमात्र अपवाद Open Guest प्लान पर Open Guest प्रोजेक्ट है, जहाँ विज़िटर खुद मापते हैं।
जब मानचित्र न दिखे#
क्रम से जाँचें:
- पते में एक
tokenहै जो समाप्त हो गया है। टोकन 60 मिनट चलते हैं, जब तक आपके सर्वर ने ज़्यादा समय न माँगा हो। मानचित्र एम्बेड करें से कोड फिर से कॉपी करें, जो आपकी कुंजी का उपयोग करता है, या अपने सर्वर से हर विज़िट के लिए नया टोकन मँगवाएँ (देखें ऊपर)। - प्रोजेक्ट निजी है। उसे केवल देखने के लिए या सार्वजनिक पर सेट करें, या मानचित्र एम्बेड करें में “केवल देखने के लिए” पर सेट करें दबाएँ।
- वेबसाइट को अनुमति नहीं है। अगर कुंजी पर वेबसाइट प्रतिबंध हैं, तो एम्बेड दिखाने वाला पेज उनमें से किसी एक पर होना चाहिए। कुछ ब्राउज़र और साइटें यह छिपाती हैं कि एम्बेड किस पेज पर है; प्रतिबंध लगे होने पर ऐसा एम्बेड अस्वीकार कर दिया जाता है।
- कुंजी बदल दी गई थी। पुरानी कुंजी नई कुंजी बनने के 24 घंटे बाद बंद हो जाती है, या अगर उसे रद्द किया गया था तो तुरंत।
- कुंजी सैंडबॉक्स कुंजी है। एम्बेड केवल लाइव कुंजियों और लाइव प्रोजेक्ट के साथ काम करते हैं।
- सदस्यता सक्रिय नहीं है, या API पहुँच निलंबित कर दी गई है: API कुंजियाँ अनुभाग यह बताता है।
अब भी मदद चाहिए?
हमारी सहायता टीम को लिखें और बताएँ कि आप क्या करने की कोशिश कर रहे थे। स्क्रीनशॉट से मदद मिलती है।