Ves al contingut

Measure Map Online per a desenvolupadors

Deixa que els visitants mesurin al teu lloc web, crea projectes per als teus clients, llegeix-ne les mesures i assabenta't dels canvis al mateix moment que es produeixen. La REST API forma part dels plans Open Guest i Enterprise.

REST API

Tria el teu pla

La pàgina Desenvolupador s'obre amb els plans Open Guest i Enterprise. Open Guest serveix per rebre sol·licituds de pressupost des del teu lloc web; Enterprise serveix per dirigir un equip, amb membres que gestiones a través de l'API.

Compara els plans

Crea una clau d'API

A la pàgina Desenvolupador, crea una clau Live per als teus projectes reals i una clau Sandbox per construir i provar: els projectes de sandbox queden apartats i els projectes de convidat de sandbox no es facturen mai. Dona a cada clau només l'accés que necessita i limita-la als teus llocs web.

Sobre les claus d'API

Envia-la amb cada sol·licitud

Cada sol·licitud va a https://api.measuremaponline.com/api/v2, amb la teva clau a la capçalera Authorization. Guarda al teu servidor les claus que poden modificar dades.

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

Què pots fer

Àrea Què pot fer el teu programari Plans
Projectes i carpetesLlista'ls, llegeix-los, crea'ls, actualitza'ls i elimina'ls; llegeix les mesures, els comentaris i el fitxer .mmp d'un projecteOpen Guest i Enterprise
ProductesLlegeix, crea, actualitza i arxiva els productes amb què poses preu a la teva feinaOpen Guest i Enterprise
Projectes de convidatInicia un projecte de convidat per a un visitant, amb les seves dades ja omplertesOpen Guest
MembresCrea, llegeix, actualitza i elimina els membres de la teva organització, i fes-los entrarEnterprise
InsercionsMostra un projecte com a mapa en directe al teu lloc webEnterprise
WebhooksRep un missatge signat al teu servidor quan passi alguna cosaOpen Guest i Enterprise

Open Guest: els visitants del teu lloc web mesuren la seva pròpia feina

Els visitants del teu lloc web mesuren la seva pròpia feina sense compte, veuen el preu mentre dibuixen i t'envien una sol·licitud de pressupost.

Com funciona

  1. Poses el teu enllaç de convidat al lloc web, com a botó o com a mapa dins d'una pàgina.
  2. Un visitant l'obre, o troba la seva adreça al mapa de la teva pàgina, i obté un projecte propi en una pestanya nova, sense haver de registrar-se enlloc.
  3. Dibuixa la seva gespa, teulada o entrada de cotxes i veu els teus preus a mesura que avança.
  4. Prem Demana un pressupost i deixa el nom, el correu electrònic i el telèfon.
  5. Reps un correu electrònic i una notificació, i el seu projecte és al teu compte.

No cal cap codi: copia el teu enllaç de convidat, o el codi del botó o del mapa, des de Desenvolupador > Enllaç de convidat.

Com funciona Open Guest

Des del teu propi formulari de pressupost

Per omplir les dades del visitant per ell, el teu servidor demana un testimoni amb la teva clau live i envia el visitant a un projecte de convidat nou. La clau no arriba mai al navegador.

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

La pàgina Desenvolupador té aquest codi a punt per al teu compte, a Enllaç de convidat > Open Guest API. Cada projecte de convidat compta en el teu ús d'Open Guest.

Enterprise: els teus membres, des del teu propi programari

Crea les persones de la teva organització des del teu propi sistema, dona'ls projectes i envia'ls a Measure Map Online ja amb la sessió iniciada.

Crea membres

Convida persones des del tauler, o crea-les amb l'API. Cada membre ocupa una plaça i rep el rol per defecte de la teva organització.

POST /users/new

Enllaça'ls amb les teves dades

Desa l'identificador d'usuari de cada membre (uid) amb el client o l'empleat a la teva base de dades, i llegeix-ne les dades quan les necessitis.

GET /users/{uid}

Crea els seus projectes

Crea un projecte al compte d'un membre i conserva el seu identificador amb la feina al teu propi sistema.

POST /users/{uid}/projects/new

Fes-los entrar

Demana un testimoni d'inici de sessió i envia el membre a l'aplicació amb ell, així no has de repartir mai contrasenyes. No disponible per a Admins i Managers, ni amb una clau de sandbox.

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

iFrame API: un mapa en directe al teu lloc web

Mostra el mapa d'un projecte, amb les teves mesures, dins de la teva pàgina web o del teu CRM. Els visitants s'hi poden moure sense compte. Tria les unitats, el tipus de mapa i un aspecte clar o fosc.

La pàgina Desenvolupador et construeix el codi: tria un projecte, comprova la vista prèvia en directe i copia'l. Les insercions formen part del pla Enterprise; amb Open Guest, insereix el teu enllaç de convidat.

Guia de la 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="Mesures de la feina">
</iframe>

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

Exemple: un projecte dins de la teva pròpia pàgina

Webhooks: assabenta't dels canvis

Afegeix l'adreça del teu servidor a la pàgina Desenvolupador i tria els esdeveniments que vulguis. Cada esdeveniment arriba com un POST amb un cos JSON, signat a la capçalera X-MMO-Signature perquè puguis comprovar que ve de nosaltres.

Els webhooks formen part dels plans Open Guest i Enterprise.

Guia dels webhooks
Esdeveniment S'envia quan
project.createdEs crea un projecte, a l'aplicació, amb l'API o des d'una inserció
project.deletedS'elimina un projecte definitivament (moure'l a la Paperera no compta)
project.comment.addedAlgú comenta un projecte
guest.project.createdUn visitant inicia un projecte de convidat i se'n coneix el correu electrònic, per exemple des del teu formulari de pressupost (Open Guest)
guest.measurement.completedUn visitant acaba de mesurar i deixa les seves dades de contacte (Open Guest)
budget.warning_reached,
budget.limit_reached
La teva despesa d'Open Guest arriba a l'avís o al límit
enterprise.user.createdS'afegeix una plaça a la teva organització, també amb inici de sessió únic (Enterprise)