Langsung ke konten

Measure Map Online untuk pengembang

Biarkan pengunjung mengukur di situs web Anda, buat proyek untuk pelanggan Anda, baca pengukuran mereka, dan ketahui setiap perubahan saat itu juga. REST API adalah bagian dari paket Open Guest dan Enterprise.

REST API

Pilih paket Anda

Halaman Pengembang tersedia pada paket Open Guest dan Enterprise. Open Guest untuk menerima permintaan estimasi dari situs web Anda; Enterprise untuk menjalankan tim, dengan anggota yang Anda kelola melalui API.

Bandingkan paket

Buat kunci API

Di halaman Pengembang, buat kunci Live untuk proyek Anda yang sebenarnya dan kunci Sandbox untuk membangun dan menguji: proyek sandbox disimpan terpisah, dan proyek tamu sandbox tidak pernah ditagih. Berikan setiap kunci hanya akses yang dibutuhkannya, dan batasi ke situs web Anda.

Tentang kunci API

Kirimkan di setiap permintaan

Setiap permintaan dikirim ke https://api.measuremaponline.com/api/v2, dengan kunci Anda di header Authorization. Simpan kunci yang dapat mengubah data di server Anda.

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

Yang dapat Anda lakukan

Bidang Yang dapat dilakukan perangkat lunak Anda Paket
Proyek dan folderMenampilkan daftar, membaca, membuat, memperbarui, dan menghapusnya; membaca pengukuran, komentar, dan file .mmp sebuah proyekOpen Guest dan Enterprise
ProdukMembaca, membuat, memperbarui, dan mengarsipkan produk yang Anda gunakan untuk memberi harga pekerjaanOpen Guest dan Enterprise
Proyek tamuMemulai proyek tamu untuk pengunjung, dengan datanya sudah terisiOpen Guest
AnggotaMembuat, membaca, memperbarui, dan menghapus anggota organisasi Anda, serta membuat mereka langsung masukEnterprise
SematanMenampilkan proyek sebagai peta langsung di situs web AndaEnterprise
WebhookMenerima pesan bertanda tangan di server Anda saat sesuatu terjadiOpen Guest dan Enterprise

Open Guest: biarkan pengunjung mengukur di situs web Anda

Pengunjung situs web Anda mengukur pekerjaannya sendiri tanpa akun, melihat harganya sambil menggambar, dan mengirimkan permintaan estimasi kepada Anda.

Cara kerjanya

  1. Anda memasang tautan tamu di situs web Anda, sebagai tombol atau sebagai peta di dalam sebuah halaman.
  2. Pengunjung membukanya dan mendapat proyek sendiri, tanpa perlu mendaftar.
  3. Mereka menggambar halaman rumput, atap, atau jalan masuk mereka, dan melihat harga Anda sambil menggambar.
  4. Mereka menekan Minta estimasi dan meninggalkan nama, email, dan nomor telepon.
  5. Anda menerima email dan notifikasi, dan proyek mereka sudah ada di akun Anda.

Tanpa kode: salin tautan tamu Anda, atau kode tombol atau petanya, dari Pengembang > Tautan tamu.

Cara kerja Open Guest

Dari formulir penawaran Anda sendiri

Untuk mengisikan data pengunjung, server Anda meminta token dengan kunci live Anda dan mengirim pengunjung ke proyek tamu baru. Kunci tidak pernah sampai ke browser.

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

Halaman Pengembang menyediakan kode ini, siap untuk akun Anda, di Tautan tamu > API Open Guest. Setiap proyek tamu dihitung dalam penggunaan Open Guest Anda.

Enterprise: anggota Anda, dari perangkat lunak Anda sendiri

Buat akun untuk orang-orang di organisasi Anda dari sistem Anda sendiri, beri mereka proyek, dan kirim mereka ke Measure Map Online dalam keadaan sudah masuk.

Buat anggota

Undang orang dari dasbor, atau buat lewat API. Setiap anggota memakai satu kursi dan mendapat peran default organisasi Anda.

POST /users/new

Tautkan ke data Anda

Simpan ID pengguna (uid) setiap anggota bersama data pelanggan atau karyawan di basis data Anda, dan baca detailnya saat Anda membutuhkannya.

GET /users/{uid}

Buat proyek mereka

Buat proyek di akun anggota dan simpan ID-nya bersama data pekerjaan itu di sistem Anda sendiri.

POST /users/{uid}/projects/new

Buat mereka langsung masuk

Minta token masuk dan kirim anggota ke aplikasi dengan token itu, sehingga Anda tidak perlu membagikan kata sandi. Tidak tersedia untuk Admin dan Manajer, atau dengan kunci sandbox.

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

iFrame API: peta langsung di situs web Anda

Tampilkan peta sebuah proyek, beserta pengukuran Anda, di dalam halaman web atau CRM Anda sendiri. Pengunjung dapat menjelajahinya tanpa akun. Pilih satuan, tipe peta, dan tampilan terang atau gelap.

Halaman Pengembang membuatkan kodenya untuk Anda: pilih proyek, periksa pratinjau langsung, lalu salin kodenya. Sematan adalah bagian dari paket Enterprise; pada Open Guest, sematkan tautan tamu Anda sebagai gantinya.

Panduan 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="Pengukuran pekerjaan">
</iframe>

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

Contoh: proyek di dalam halaman Anda sendiri

Webhook: ketahui setiap perubahan

Tambahkan alamat server Anda di halaman Pengembang dan pilih peristiwa yang Anda inginkan. Setiap peristiwa tiba sebagai POST dengan isi JSON, ditandatangani di header X-MMO-Signature agar Anda dapat memastikan peristiwa itu berasal dari kami.

Webhook adalah bagian dari paket Open Guest dan Enterprise.

Panduan webhook
Peristiwa Dikirim saat
project.createdSebuah proyek dibuat, di aplikasi, melalui API, atau dari sematan
project.deletedSebuah proyek dihapus permanen (memindahkannya ke Sampah tidak dihitung)
project.comment.addedSeseorang mengomentari sebuah proyek
guest.project.createdPengunjung memulai proyek tamu dan alamat emailnya diketahui, misalnya dari formulir penawaran Anda (Open Guest)
guest.measurement.completedPengunjung selesai mengukur dan meninggalkan detail kontaknya (Open Guest)
budget.warning_reached,
budget.limit_reached
Pengeluaran Open Guest Anda mencapai ambang peringatan atau batas Anda
enterprise.user.createdSebuah kursi ditambahkan ke organisasi Anda, termasuk melalui single sign-on (Enterprise)