İçeriğe geç

Measure Map Online geliştiriciler için

Ziyaretçilerin web sitenizde ölçüm yapmasını sağlayın, müşterileriniz için projeler oluşturun, ölçümlerini okuyun ve değişikliklerden olduğu anda haberdar olun. REST API, Open Guest ve Enterprise planlarının bir parçasıdır.

REST API

Planınızı seçin

Geliştirici sayfası Open Guest ve Enterprise planlarında açılır. Open Guest, web sitenizden teklif talepleri almak içindir; Enterprise ise API ile yönettiğiniz üyelerle bir ekibi yürütmek içindir.

Planları karşılaştırın

Bir API anahtarı oluşturun

Geliştirici sayfasında gerçek projeleriniz için bir Live anahtarı, geliştirme ve test için bir Sandbox anahtarı oluşturun: sandbox projeleri ayrı kalır ve sandbox misafir projeleri asla faturalandırılmaz. Her anahtara yalnızca ihtiyaç duyduğu erişimi verin ve web sitelerinizle sınırlayın.

API anahtarları hakkında

Her istekte gönderin

Her istek https://api.measuremaponline.com/api/v2 adresine gider ve anahtarınız Authorization başlığında yer alır. Veriyi değiştirebilen anahtarları sunucunuzda tutun.

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

Neler yapabilirsiniz

Alan Yazılımınız neler yapabilir Planlar
Projeler ve klasörlerListeleyin, okuyun, oluşturun, güncelleyin ve silin; bir projenin ölçümlerini, yorumlarını ve .mmp dosyasını okuyunOpen Guest ve Enterprise
Ürünlerİşinizi fiyatlandırdığınız ürünleri okuyun, oluşturun, güncelleyin ve arşivleyinOpen Guest ve Enterprise
Misafir projeleriBir ziyaretçi için, bilgileri doldurulmuş bir misafir projesi başlatınOpen Guest
ÜyelerOrganizasyonunuzun üyelerini oluşturun, okuyun, güncelleyin ve kaldırın; oturumlarını açınEnterprise
GömmelerBir projeyi web sitenizde canlı harita olarak gösterinEnterprise
Webhook'larBir şey olduğunda sunucunuza imzalı bir mesaj alınOpen Guest ve Enterprise

Open Guest: web sitenizin ziyaretçileri kendi işlerini ölçer

Web sitenizin ziyaretçileri hesap açmadan kendi işlerini ölçer, çizerken fiyatını görür ve size teklif talebi gönderir.

Nasıl çalışır

  1. Misafir bağlantınızı web sitenize koyarsınız; düğme olarak veya bir sayfanın içinde harita olarak.
  2. Bir ziyaretçi bağlantıyı açar veya sayfanızdaki haritada adresini bulur ve üye olmadan yeni bir sekmede kendi projesine kavuşur.
  3. Çimini, çatısını veya garaj yolunu çizer ve çizerken fiyatlarınızı görür.
  4. Fiyat teklifi iste düğmesine basar ve adını, e-postasını ve telefonunu bırakır.
  5. Bir e-posta ve bildirim alırsınız, ziyaretçinin projesi de hesabınızda olur.

Kod gerekmez: misafir bağlantınızı veya onun düğme ya da harita kodunu Geliştirici > Misafir bağlantısı bölümünden kopyalayın.

Open Guest nasıl çalışır

Kendi teklif formunuzdan

Ziyaretçinin bilgilerini onun yerine doldurmak için sunucunuz Live anahtarınızla bir belirteç ister ve ziyaretçiyi yeni bir misafir projesine yönlendirir. Anahtar asla tarayıcıya ulaşmaz.

// 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');
}

Geliştirici sayfasında bu kod hesabınız için hazırdır; Misafir bağlantısı > Open Guest API altında. Her misafir projesi Open Guest kullanımınıza sayılır.

Enterprise: üyeleriniz, kendi yazılımınızdan

Organizasyonunuzdaki kişileri kendi sisteminizden oluşturun, onlara projeler verin ve Measure Map Online'a zaten oturum açmış olarak gönderin.

Üyeler oluşturun

Kişileri panelden davet edin veya API ile oluşturun. Her üye bir koltuk kullanır ve organizasyonunuzun varsayılan rolünü alır.

POST /users/new

Onları kayıtlarınıza bağlayın

Her üyenin kullanıcı kimliğini (uid) veritabanınızdaki müşteri veya çalışanla birlikte saklayın ve gerektiğinde bilgilerini okuyun.

GET /users/{uid}

Projelerini oluşturun

Bir üyenin hesabında proje oluşturun ve kimliğini kendi sisteminizdeki işle birlikte saklayın.

POST /users/{uid}/projects/new

Oturumlarını açın

Bir oturum açma belirteci isteyin ve üyeyi onunla uygulamaya gönderin; böylece parola dağıtmanız gerekmez. Admin ve Manager'lar için veya Sandbox anahtarıyla kullanılamaz.

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

iFrame API: web sitenizde canlı bir harita

Bir projenin haritasını, ölçümlerinizle birlikte, kendi web sayfanızda veya CRM'inizde gösterin. Ziyaretçiler hesap açmadan haritada gezinebilir. Birimleri, harita türünü ve açık ya da koyu görünümü seçin.

Geliştirici sayfası kodu sizin için oluşturur: bir proje seçin, canlı önizlemeyi kontrol edin ve kopyalayın. Gömmeler Enterprise planının bir parçasıdır; Open Guest'te bunun yerine misafir bağlantınızı gömün.

iFrame API rehberi
<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="İşin ölçümleri">
</iframe>

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

Örnek: kendi sayfanızın içinde bir proje

Webhook'lar: değişikliklerden haberdar olun

Geliştirici sayfasına sunucunuzun adresini ekleyin ve istediğiniz olayları seçin. Her olay JSON gövdeli bir POST olarak gelir ve bizden geldiğini doğrulayabilmeniz için X-MMO-Signature başlığında imzalanır.

Webhook'lar Open Guest ve Enterprise planlarının bir parçasıdır.

Webhook rehberi
Olay Gönderilme zamanı
project.createdUygulamada, API ile veya bir gömmeden proje oluşturulduğunda
project.deletedBir proje kalıcı olarak silindiğinde (Çöp kutusuna taşımak sayılmaz)
project.comment.addedBiri bir projeye yorum yaptığında
guest.project.createdBir ziyaretçi misafir projesi başlattığında ve e-posta adresi biliniyorsa, örneğin teklif formunuzdan (Open Guest)
guest.measurement.completedBir ziyaretçi ölçümü bitirip iletişim bilgilerini bıraktığında (Open Guest)
budget.warning_reached,
budget.limit_reached
Open Guest harcamanız uyarı eşiğinize veya sınırınıza ulaştığında
enterprise.user.createdOrganizasyonunuza bir koltuk eklendiğinde, tek oturum açma ile de (Enterprise)