Hoppa till innehållet

Measure Map Online för utvecklare

Låt besökare mäta på din webbplats, skapa projekt åt dina kunder, läs deras mätningar och få veta om ändringar i samma stund som de sker. REST API ingår i planerna Open Guest och Enterprise.

REST API

Välj din plan

Utvecklarsidan öppnas i planerna Open Guest och Enterprise. Open Guest är till för att ta emot offertförfrågningar från din webbplats; Enterprise är till för att driva ett team, med medlemmar som du hanterar via API:et.

Jämför planer

Skapa en API-nyckel

På utvecklarsidan skapar du en Live-nyckel för dina riktiga projekt och en Sandbox-nyckel för att bygga och testa: sandlådeprojekt hålls separata, och gästprojekt i sandlådan faktureras aldrig. Ge varje nyckel bara den åtkomst den behöver och begränsa den till dina webbplatser.

Om API-nycklar

Skicka den med varje anrop

Varje anrop går till https://api.measuremaponline.com/api/v2, med din nyckel i rubriken Authorization. Behåll nycklar som kan ändra data på din server.

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

Vad du kan göra

Område Vad din programvara kan göra Planer
Projekt och mapparLista, läs, skapa, uppdatera och ta bort dem; läs ett projekts mätningar, kommentarer och .mmp-filOpen Guest och Enterprise
ProdukterLäs, skapa, uppdatera och arkivera de produkter du prissätter ditt arbete medOpen Guest och Enterprise
GästprojektStarta ett gästprojekt åt en besökare, med besökarens uppgifter ifylldaOpen Guest
MedlemmarSkapa, läs, uppdatera och ta bort medlemmar i din organisation, och logga in demEnterprise
InbäddningarVisa ett projekt som en levande karta på din webbplatsEnterprise
WebhooksFå ett signerat meddelande till din server när något händerOpen Guest och Enterprise

Open Guest: din webbplats besökare mäter sitt eget jobb

Din webbplats besökare mäter sitt eget jobb, utan konto, ser priset medan de ritar och skickar dig en offertförfrågan.

Så fungerar det

  1. Du lägger din gästlänk på din webbplats, som knapp eller som karta på en sida.
  2. En besökare öppnar den, eller hittar sin adress på kartan på din sida, och får ett eget projekt i en ny flik, utan att behöva registrera sig.
  3. Hen ritar sin gräsmatta, sitt tak eller sin uppfart och ser dina priser medan hen ritar.
  4. Hen trycker på Begär en offert och lämnar sitt namn, sin e-postadress och sitt telefonnummer.
  5. Du får ett e-postmeddelande och en avisering, och besökarens projekt finns på ditt konto.

Ingen kod behövs: kopiera din gästlänk, eller knapp- eller kartkoden för den, från Utvecklare > Gästlänk.

Så fungerar Open Guest

Från ditt eget offertformulär

För att fylla i besökarens uppgifter åt hen ber din server om en token med din Live-nyckel och skickar besökaren till ett nytt gästprojekt. Nyckeln når aldrig webbläsaren.

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

Utvecklarsidan har den här koden färdig för ditt konto, under Gästlänk > Open Guest API. Varje gästprojekt räknas mot din Open Guest-användning.

Enterprise: dina medlemmar, från din egen programvara

Skapa personerna i din organisation från ditt eget system, ge dem projekt och skicka in dem i Measure Map Online redan inloggade.

Skapa medlemmar

Bjud in personer från instrumentpanelen eller skapa dem med API:et. Varje medlem tar en plats och får din organisations standardroll.

POST /users/new

Koppla dem till dina register

Lagra varje medlems användar-ID (uid) hos kunden eller medarbetaren i din databas och läs uppgifterna när du behöver dem.

GET /users/{uid}

Skapa deras projekt

Skapa ett projekt på en medlems konto och spara dess ID vid jobbet i ditt eget system.

POST /users/{uid}/projects/new

Logga in dem

Be om en inloggningstoken och skicka medlemmen till appen med den, så du aldrig behöver dela ut lösenord. Finns inte för Admin och Manager, eller med en Sandbox-nyckel.

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

iFrame API: en levande karta på din webbplats

Visa ett projekts karta, med dina mätningar, på din egen webbsida eller i ditt CRM. Besökare kan flytta runt på den utan konto. Välj enheter, karttyp och ett ljust eller mörkt utseende.

Utvecklarsidan bygger koden åt dig: välj ett projekt, kontrollera förhandsvisningen och kopiera den. Inbäddningar ingår i Enterprise-planen; i Open Guest bäddar du in din gästlänk i stället.

Guide till 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="Jobbets mätningar">
</iframe>

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

Exempel: ett projekt på din egen sida

Webhooks: få veta om ändringar

Lägg till din servers adress på utvecklarsidan och välj de händelser du vill ha. Varje händelse kommer som en POST med en JSON-kropp, signerad i rubriken X-MMO-Signature så att du kan kontrollera att den kommer från oss.

Webhooks ingår i planerna Open Guest och Enterprise.

Guide till webhooks
Händelse Skickas när
project.createdEtt projekt skapas, i appen, via API:et eller från en inbäddning
project.deletedEtt projekt tas bort för gott (att flytta det till papperskorgen räknas inte)
project.comment.addedNågon kommenterar ett projekt
guest.project.createdEn besökare startar ett gästprojekt och dennes e-postadress är känd, till exempel från ditt offertformulär (Open Guest)
guest.measurement.completedEn besökare är klar med mätningen och lämnar sina kontaktuppgifter (Open Guest)
budget.warning_reached,
budget.limit_reached
Din Open Guest-kostnad når din varning eller din gräns
enterprise.user.createdEn plats läggs till i din organisation, även via single sign-on (Enterprise)