सामग्री पर जाएँ

डेवलपरों के लिए Measure Map Online

विज़िटर को अपनी वेबसाइट पर मापने दें, अपने ग्राहकों के लिए प्रोजेक्ट बनाएँ, उनके माप पढ़ें, और बदलाव होते ही उनकी सूचना पाएँ। REST API Open Guest और Enterprise प्लान का हिस्सा है।

REST API

अपना प्लान चुनें

डेवलपर पेज Open Guest और Enterprise प्लान पर खुलता है। Open Guest आपकी वेबसाइट से अनुमान अनुरोध पाने के लिए है; Enterprise टीम चलाने के लिए है, जिसके सदस्यों को आप API से प्रबंधित करते हैं।

प्लान की तुलना करें

API कुंजी बनाएँ

डेवलपर पेज पर, अपने असली प्रोजेक्ट के लिए एक लाइव कुंजी और बनाने व परखने के लिए एक सैंडबॉक्स कुंजी बनाएँ: सैंडबॉक्स प्रोजेक्ट अलग रखे जाते हैं, और सैंडबॉक्स अतिथि प्रोजेक्ट का कभी बिल नहीं बनता। हर कुंजी को केवल उतनी पहुँच दें जितनी उसे चाहिए, और उसे अपनी वेबसाइटों तक सीमित रखें।

API कुंजियों के बारे में

हर अनुरोध के साथ इसे भेजें

हर अनुरोध https://api.measuremaponline.com/api/v2 पर भेजा जाता है, और आपकी कुंजी Authorization हेडर में होती है। जो कुंजियाँ डेटा बदल सकती हैं, उन्हें अपने सर्वर पर ही रखें।

curl https://api.measuremaponline.com/api/v2/projects/PROJECT_ID \
  -H "Authorization: YOUR_API_KEY"

आप क्या कर सकते हैं

क्षेत्र आपका सॉफ़्टवेयर क्या कर सकता है प्लान
प्रोजेक्ट और फ़ोल्डरउनकी सूची देखें, उन्हें पढ़ें, बनाएँ, अपडेट करें और हटाएँ; किसी प्रोजेक्ट के माप, टिप्पणियाँ और .mmp फ़ाइल पढ़ेंOpen Guest और Enterprise
उत्पादजिन उत्पादों से आप अपने काम की कीमत लगाते हैं, उन्हें पढ़ें, बनाएँ, अपडेट करें और संग्रहित करेंOpen Guest और Enterprise
अतिथि प्रोजेक्टकिसी विज़िटर के लिए अतिथि प्रोजेक्ट शुरू करें, उसके विवरण पहले से भरे हुएOpen Guest
सदस्यअपने संगठन के सदस्यों को बनाएँ, पढ़ें, अपडेट करें और हटाएँ, और उन्हें साइन इन कराएँEnterprise
एम्बेडकिसी प्रोजेक्ट को अपनी वेबसाइट पर लाइव मानचित्र के रूप में दिखाएँEnterprise
वेबहुककुछ होने पर अपने सर्वर पर सिग्नेचर वाला संदेश पाएँOpen Guest और Enterprise

Open Guest: विज़िटर को अपनी वेबसाइट पर मापने दें

आपकी वेबसाइट के विज़िटर बिना खाते के अपना काम खुद मापते हैं, ड्रॉ करते समय उसकी कीमत देखते हैं, और आपको अनुमान का अनुरोध भेजते हैं।

यह कैसे काम करता है

  1. आप अपना अतिथि लिंक अपनी वेबसाइट पर लगाते हैं, बटन के रूप में या किसी पेज के अंदर मानचित्र के रूप में।
  2. कोई विज़िटर उसे खोलता है और उसे अपना एक प्रोजेक्ट मिलता है, बिना किसी साइन अप के।
  3. वह अपना लॉन, छत या ड्राइववे बनाता है, और साथ-साथ आपकी कीमतें देखता है।
  4. वह अनुमान का अनुरोध करें दबाता है और अपना नाम, ईमेल और फ़ोन नंबर छोड़ता है।
  5. आपको एक ईमेल और एक सूचना मिलती है, और उसका प्रोजेक्ट आपके खाते में होता है।

कोड की ज़रूरत नहीं: डेवलपर > अतिथि लिंक से अपना अतिथि लिंक, या उसके लिए बटन या मानचित्र का कोड कॉपी करें।

Open Guest कैसे काम करता है

अपने कोटेशन फ़ॉर्म से

विज़िटर का विवरण उसकी ओर से भरने के लिए, आपका सर्वर आपकी लाइव कुंजी से एक टोकन माँगता है और विज़िटर को एक नए अतिथि प्रोजेक्ट पर भेजता है। कुंजी कभी ब्राउज़र तक नहीं पहुँचती।

// Node.js 18+ with Express. Your API key stays on this server.
const express = require('express');
const app = express();

app.get('/start-measuring', async (req, res) => {
  // A token lets one visitor start one project in your account.
  const reply = await fetch('https://api.measuremaponline.com/api/v2/auth/token', {
    method: 'POST',
    headers: {'Authorization': process.env.MMO_API_KEY, 'Content-Type': 'application/json'},
    body: '{}',
  });
  if (!reply.ok) {
    return res.sendStatus(502);
  }
  const {token} = await reply.json();
  const name = String(req.query.name || '');
  const email = String(req.query.email || '');
  // URLSearchParams encodes every value: "Smith & Sons" arrives whole.
  const params = new URLSearchParams({
    token,
    name,                       // the project's name in your account
    description: email,         // any text you want to search by later
    guest_name: name,           // shown in the email you receive
    guest_email: email,
    // folder_id: 'FOLDER_ID',  // optional: the folder new projects go into
  });
  res.redirect('https://app.measuremaponline.com/app/projects/guest/new?' + params.toString());
});

app.listen(3000);
// On your page: call this from the button on your quote form.
function startMeasuring(name, email) {
  const params = new URLSearchParams({name, email});
  window.open('/start-measuring?' + params.toString(), '_blank', 'noopener');
}

डेवलपर पेज पर यह कोड आपके खाते के लिए तैयार है, अतिथि लिंक > Open Guest API में। हर अतिथि प्रोजेक्ट आपके Open Guest उपयोग में गिना जाता है।

Enterprise: आपके सदस्य, आपके अपने सॉफ़्टवेयर से

अपने सिस्टम से अपने संगठन के लोगों को बनाएँ, उन्हें प्रोजेक्ट दें, और उन्हें पहले से साइन इन करके Measure Map Online में भेजें।

सदस्य बनाएँ

डैशबोर्ड से लोगों को आमंत्रित करें, या उन्हें API से बनाएँ। हर सदस्य एक सीट लेता है और उसे आपके संगठन की डिफ़ॉल्ट भूमिका मिलती है।

POST /users/new

उन्हें अपने रिकॉर्ड से जोड़ें

हर सदस्य की यूज़र ID (uid) अपने डेटाबेस में संबंधित ग्राहक या कर्मचारी के साथ सहेजें, और ज़रूरत पड़ने पर उसका विवरण पढ़ें।

GET /users/{uid}

उनके प्रोजेक्ट बनाएँ

किसी सदस्य के खाते में प्रोजेक्ट बनाएँ और उसकी ID अपने सिस्टम में उस काम के साथ रखें।

POST /users/{uid}/projects/new

उन्हें साइन इन कराएँ

साइन-इन टोकन माँगें और उसके साथ सदस्य को ऐप पर भेजें, ताकि आपको कभी पासवर्ड न बाँटने पड़ें। यह एडमिन और प्रबंधकों के लिए उपलब्ध नहीं है, और सैंडबॉक्स कुंजी के साथ भी नहीं।

POST /auth/{uid}/login
https://app.measuremaponline.com/dashboard?sit=TOKEN

iFrame API: आपकी वेबसाइट पर लाइव मानचित्र

किसी प्रोजेक्ट का मानचित्र, आपके माप के साथ, अपने वेब पेज या CRM के अंदर दिखाएँ। विज़िटर बिना खाते के उस पर घूम सकते हैं। इकाइयाँ, मानचित्र का प्रकार और लाइट या डार्क रूप चुनें।

डेवलपर पेज आपके लिए कोड बनाता है: एक प्रोजेक्ट चुनें, लाइव पूर्वावलोकन देखें और कोड कॉपी करें। एम्बेड Enterprise प्लान का हिस्सा हैं; Open Guest पर, इसके बजाय अपना अतिथि लिंक एम्बेड करें।

iFrame API गाइड
<iframe
  src="https://app.measuremaponline.com/iframe_api?pid=PROJECT_ID&key=YOUR_API_KEY&ms=metric&maptype=satellite&theme=auto"
  width="100%" height="500" style="border: 0"
  title="काम के माप">
</iframe>

ms: metric या imperial · maptype: satellite, map, hybrid या terrain · theme: auto, light या dark

उदाहरण: आपके अपने पेज के अंदर एक प्रोजेक्ट

वेबहुक: बदलावों की सूचना पाएँ

डेवलपर पेज पर अपने सर्वर का पता जोड़ें और अपनी ज़रूरत के इवेंट चुनें। हर इवेंट JSON बॉडी के साथ एक POST के रूप में आता है, जिसके X-MMO-Signature हेडर में सिग्नेचर होता है, ताकि आप जाँच सकें कि वह हमसे ही आया है।

वेबहुक Open Guest और Enterprise प्लान का हिस्सा हैं।

वेबहुक गाइड
इवेंट कब भेजा जाता है
project.createdकोई प्रोजेक्ट बनता है: ऐप में, API से या किसी एम्बेड से
project.deletedकोई प्रोजेक्ट स्थायी रूप से हटाया जाता है (उसे ट्रैश में ले जाना नहीं गिना जाता)
project.comment.addedकोई किसी प्रोजेक्ट पर टिप्पणी करता है
guest.project.createdकोई विज़िटर अतिथि प्रोजेक्ट शुरू करता है और उसका ईमेल पता मालूम होता है, उदाहरण के लिए आपके कोटेशन फ़ॉर्म से (Open Guest)
guest.measurement.completedकोई विज़िटर मापना पूरा करता है और अपना संपर्क विवरण छोड़ता है (Open Guest)
budget.warning_reached,
budget.limit_reached
आपका Open Guest खर्च आपकी चेतावनी राशि या आपकी सीमा तक पहुँचता है
enterprise.user.createdआपके संगठन में एक सीट जुड़ती है, सिंगल साइन-ऑन के ज़रिए भी (Enterprise)