Przejdź do treści

Measure Map Online dla deweloperów

Pozwól odwiedzającym mierzyć na Twojej stronie, twórz projekty dla swoich klientów, odczytuj ich pomiary i dowiaduj się o zmianach w chwili, gdy nastąpią. REST API jest częścią planów Open Guest i Enterprise.

REST API

Wybierz swój plan

Strona Deweloper jest dostępna w planach Open Guest i Enterprise. Open Guest służy do przyjmowania próśb o wycenę ze strony internetowej; Enterprise do prowadzenia zespołu, z członkami zarządzanymi przez API.

Porównaj plany

Utwórz klucz API

Na stronie Deweloper utwórz klucz Live do prawdziwych projektów i klucz Sandbox do budowania i testowania: projekty z piaskownicy są oddzielone, a gościnne projekty z piaskownicy nigdy nie są rozliczane. Każdemu kluczowi nadaj tylko potrzebny dostęp i ogranicz go do swoich stron.

O kluczach API

Wysyłaj go z każdym żądaniem

Każde żądanie trafia na https://api.measuremaponline.com/api/v2, z Twoim kluczem w nagłówku Authorization. Klucze, które mogą zmieniać dane, trzymaj na swoim serwerze.

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

Co możesz zrobić

Obszar Co może robić Twoje oprogramowanie Plany
Projekty i folderyWyświetlaj, odczytuj, twórz, aktualizuj i usuwaj je; odczytuj pomiary projektu, komentarze i plik .mmpOpen Guest i Enterprise
ProduktyOdczytuj, twórz, aktualizuj i archiwizuj produkty, którymi wyceniasz swoją pracęOpen Guest i Enterprise
Projekty gościnneRozpocznij projekt gościnny dla odwiedzającego, z jego już wypełnionymi danymiOpen Guest
CzłonkowieTwórz, odczytuj, aktualizuj i usuwaj członków swojej organizacji oraz loguj ichEnterprise
OsadzaniePokaż projekt jako działającą mapę na swojej stronieEnterprise
WebhookiOtrzymuj na swój serwer podpisaną wiadomość, gdy coś się wydarzyOpen Guest i Enterprise

Open Guest: odwiedzający Twoją stronę sami mierzą swoje zlecenie

Odwiedzający Twoją stronę sami mierzą swoje zlecenie, bez konta, widzą jego cenę w trakcie rysowania i wysyłają Ci prośbę o wycenę.

Jak to działa

  1. Umieszczasz link dla gości na swojej stronie, jako przycisk lub mapę osadzoną na podstronie.
  2. Odwiedzający otwiera go albo znajduje swój adres na mapie na Twojej stronie i dostaje własny projekt w nowej karcie, bez żadnej rejestracji.
  3. Rysuje swój trawnik, dach lub podjazd i na bieżąco widzi Twoje ceny.
  4. Naciska Poproś o wycenę i zostawia imię, e-mail i telefon.
  5. Dostajesz e-mail i powiadomienie, a jego projekt trafia na Twoje konto.

Bez kodowania: skopiuj swój link dla gości albo kod przycisku czy mapy dla niego z Deweloper > Link dla gości.

Jak działa Open Guest

Z własnego formularza wyceny

Aby wypełnić dane odwiedzającego za niego, Twój serwer prosi o token za pomocą klucza Live i kieruje odwiedzającego do nowego projektu gościnnego. Klucz nigdy nie trafia do przeglądarki.

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

Strona Deweloper ma ten kod gotowy dla Twojego konta, w sekcji Link dla gości > Open Guest API. Każdy projekt gościnny wlicza się do Twojego zużycia Open Guest.

Enterprise: Twoi członkowie, z własnego oprogramowania

Twórz osoby ze swojej organizacji z poziomu własnego systemu, przydzielaj im projekty i wprowadzaj ich do Measure Map Online już zalogowanych.

Twórz członków

Zapraszaj osoby z panelu albo twórz je przez API. Każdy członek zajmuje jedno miejsce i dostaje domyślną rolę Twojej organizacji.

POST /users/new

Powiąż ich ze swoimi rekordami

Zapisz identyfikator użytkownika (uid) każdego członka przy kliencie lub pracowniku w swojej bazie i odczytuj jego dane, gdy będą potrzebne.

GET /users/{uid}

Twórz ich projekty

Utwórz projekt na koncie członka i zachowaj jego identyfikator przy zleceniu w swoim systemie.

POST /users/{uid}/projects/new

Loguj ich

Poproś o token logowania i wyślij z nim członka do aplikacji, dzięki czemu nigdy nie musisz przekazywać haseł. Niedostępne dla Adminów i Managerów ani z kluczem Sandbox.

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

iFrame API: działająca mapa na Twojej stronie

Pokaż mapę projektu z Twoimi pomiarami na własnej stronie internetowej lub w CRM. Odwiedzający mogą po niej się poruszać bez konta. Wybierz jednostki, typ mapy oraz jasny lub ciemny wygląd.

Strona Deweloper tworzy kod za Ciebie: wybierz projekt, sprawdź podgląd na żywo i skopiuj go. Osadzanie jest częścią planu Enterprise; w planie Open Guest osadź zamiast tego swój link dla gości.

Przewodnik po 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="Pomiary zlecenia">
</iframe>

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

Przykład: projekt na Twojej własnej stronie

Webhooki: bądź na bieżąco ze zmianami

Dodaj adres swojego serwera na stronie Deweloper i wybierz zdarzenia, które cię interesują. Każde zdarzenie przychodzi jako POST z treścią JSON, podpisane w nagłówku X-MMO-Signature, abyś mógł sprawdzić, że pochodzi od nas.

Webhooki są częścią planów Open Guest i Enterprise.

Przewodnik po webhookach
Zdarzenie Wysyłane, gdy
project.createdPowstaje projekt, w aplikacji, przez API lub z osadzonej mapy
project.deletedProjekt zostaje usunięty na stałe (przeniesienie do Kosza się nie liczy)
project.comment.addedKtoś komentuje projekt
guest.project.createdOdwiedzający rozpoczyna projekt gościnny i znamy jego adres e-mail, na przykład z Twojego formularza wyceny (Open Guest)
guest.measurement.completedOdwiedzający kończy mierzenie i zostawia dane kontaktowe (Open Guest)
budget.warning_reached,
budget.limit_reached
Wydatki na Open Guest osiągają próg ostrzegawczy lub limit
enterprise.user.createdDo Twojej organizacji zostaje dodane miejsce, także przez jednokrotne logowanie (Enterprise)