Measure Map Online for utviklere
La besøkende måle på nettstedet ditt, opprett prosjekter for kundene dine, les målingene deres, og få vite om endringer i det øyeblikket de skjer. REST API er en del av planene Open Guest og Enterprise.
REST API
Velg planen din
Utviklersiden åpnes med planene Open Guest og Enterprise. Open Guest er for å motta tilbudsforespørsler fra nettstedet ditt; Enterprise er for å drive et team, med medlemmer du administrerer via API-et.
Sammenlign planerOpprett en API-nøkkel
På utviklersiden oppretter du en Live-nøkkel for de ekte prosjektene dine og en Sandbox-nøkkel for å bygge og teste: sandbox-prosjekter holdes adskilt, og sandbox-gjesteprosjekter faktureres aldri. Gi hver nøkkel bare tilgangen den trenger, og begrens den til nettstedene dine.
Om API-nøklerSend den med hver forespørsel
Hver forespørsel går til https://api.measuremaponline.com/api/v2, med nøkkelen din i headeren Authorization. Oppbevar nøkler som kan endre data, på serveren din.
curl https://api.measuremaponline.com/api/v2/projects/PROJECT_ID \
-H "Authorization: YOUR_API_KEY"
Hva du kan gjøre
| Område | Hva programvaren din kan gjøre | Planer |
|---|---|---|
| Prosjekter og mapper | List opp, les, opprett, oppdater og slett dem; les et prosjekts målinger, kommentarer og .mmp-fil | Open Guest og Enterprise |
| Produkter | Les, opprett, oppdater og arkiver produktene du prisregner arbeidet ditt med | Open Guest og Enterprise |
| Gjesteprosjekter | Start et gjesteprosjekt for en besøkende, med opplysningene deres utfylt | Open Guest |
| Medlemmer | Opprett, les, oppdater og fjern medlemmene i organisasjonen din, og logg dem inn | Enterprise |
| Innbygginger | Vis et prosjekt som et levende kart på nettstedet ditt | Enterprise |
| Webhooks | Få en signert melding på serveren din når noe skjer | Open Guest og Enterprise |
Open Guest: de besøkende på nettstedet ditt måler sin egen jobb
De besøkende på nettstedet ditt måler sin egen jobb uten konto, ser prisen mens de tegner, og sender deg en forespørsel om tilbud.
Slik fungerer det
- Du legger gjestelenken din på nettstedet ditt, som en knapp eller som et kart inne på en side.
- En besøkende åpner den, eller finner adressen sin på kartet på siden din, og får et eget prosjekt i en ny fane, uten å måtte melde seg på noe.
- De tegner plenen, taket eller innkjørselen sin og ser prisene dine underveis.
- De trykker på Be om et tilbud og legger igjen navn, e-post og telefonnummer.
- Du får en e-post og et varsel, og prosjektet deres ligger på kontoen din.
Ingen kode nødvendig: kopier gjestelenken din, eller knappe- eller kartkoden for den, fra Utvikler > Gjestelenke.
Slik fungerer Open GuestFra ditt eget tilbudsskjema
For å fylle ut den besøkendes opplysninger for dem ber serveren din om et token med live-nøkkelen din og sender den besøkende til et nytt gjesteprosjekt. Nøkkelen når aldri nettleseren.
// 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');
}
Utviklersiden har denne koden klar for kontoen din, under Gjestelenke > Open Guest API. Hvert gjesteprosjekt teller med i Open Guest-bruken din.
Enterprise: medlemmene dine, fra din egen programvare
Opprett menneskene i organisasjonen din fra ditt eget system, gi dem prosjekter, og send dem inn i Measure Map Online allerede innlogget.
Opprett medlemmer
Inviter folk fra dashbordet, eller opprett dem med API-et. Hvert medlem bruker en plass og får organisasjonens standardrolle.
POST /users/newKoble dem til dataene dine
Lagre hvert medlems bruker-ID (uid) sammen med kunden eller den ansatte i databasen din, og les opplysningene deres når du trenger dem.
GET /users/{uid}Opprett prosjektene deres
Opprett et prosjekt på et medlems konto, og behold ID-en sammen med jobben i ditt eget system.
POST /users/{uid}/projects/newLogg dem inn
Be om et innloggingstoken og send medlemmet til appen med det, så du aldri trenger å dele ut passord. Ikke tilgjengelig for Admins og Managers, eller med en sandbox-nøkkel.
POST /auth/{uid}/login
https://app.measuremaponline.com/dashboard?sit=TOKENiFrame API: et levende kart på nettstedet ditt
Vis kartet til et prosjekt, med målingene dine, inne i din egen nettside eller ditt CRM. Besøkende kan bevege seg rundt på det uten konto. Velg enheter, korttype og et lyst eller mørkt utseende.
Utviklersiden bygger koden for deg: velg et prosjekt, sjekk forhåndsvisningen og kopier den. Innbygginger er en del av Enterprise-planen; med Open Guest bygger du i stedet inn gjestelenken din.
Guide til 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="Målinger for jobben">
</iframe>
ms: metric eller imperial
· maptype: satellite, map, hybrid eller terrain
· theme: auto, light eller dark
Webhooks: få vite om endringer
Legg til adressen til serveren din på utviklersiden og velg hendelsene du vil ha. Hver hendelse kommer som en POST med en JSON-body, signert i headeren X-MMO-Signature så du kan kontrollere at den kommer fra oss.
Webhooks er en del av planene Open Guest og Enterprise.
Guide til webhooks| Hendelse | Sendes når |
|---|---|
project.created | Et prosjekt opprettes, i appen, via API-et eller fra en innbygging |
project.deleted | Et prosjekt slettes for godt (å flytte det til Papirkurven teller ikke) |
project.comment.added | Noen kommenterer et prosjekt |
guest.project.created | En besøkende starter et gjesteprosjekt og e-postadressen deres er kjent, for eksempel fra tilbudsskjemaet ditt (Open Guest) |
guest.measurement.completed | En besøkende er ferdig med å måle og legger igjen kontaktopplysningene sine (Open Guest) |
budget.warning_reached,budget.limit_reached | Open Guest-forbruket ditt når varselgrensen eller grensen din |
enterprise.user.created | En plass legges til i organisasjonen din, også via single sign-on (Enterprise) |