Zum Inhalt springen

Measure Map Online für Entwickler

Lassen Sie Besucher auf Ihrer Website messen, legen Sie Projekte für Ihre Kunden an, lesen Sie deren Messungen und erfahren Sie von Änderungen in dem Moment, in dem sie geschehen. Die REST-API gehört zu den Tarifen Open Guest und Enterprise.

REST-API

Tarif wählen

Die Entwicklerseite steht in den Tarifen Open Guest und Enterprise zur Verfügung. Open Guest ist für Angebotsanfragen über Ihre Website gedacht, Enterprise für die Führung eines Teams, dessen Mitglieder Sie über die API verwalten.

Tarife vergleichen

API-Schlüssel erstellen

Erstellen Sie auf der Entwicklerseite einen Live-Schlüssel für Ihre echten Projekte und einen Sandbox-Schlüssel zum Entwickeln und Testen: Sandbox-Projekte bleiben getrennt, und Sandbox-Gastprojekte werden nie abgerechnet. Geben Sie jedem Schlüssel nur den Zugriff, den er braucht, und beschränken Sie ihn auf Ihre Websites.

Mehr über API-Schlüssel

Bei jeder Anfrage mitsenden

Jede Anfrage geht an https://api.measuremaponline.com/api/v2, mit Ihrem Schlüssel im Header Authorization. Bewahren Sie Schlüssel, die Daten ändern können, auf Ihrem Server auf.

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

Was Sie damit tun können

Bereich Was Ihre Software tun kann Tarife
Projekte und OrdnerAuflisten, lesen, erstellen, ändern und löschen; Messungen, Kommentare und die .mmp-Datei eines Projekts lesenOpen Guest und Enterprise
ProdukteDie Produkte, mit denen Sie Ihre Arbeit kalkulieren, lesen, erstellen, ändern und archivierenOpen Guest und Enterprise
GastprojekteEin Gastprojekt für einen Besucher starten, mit bereits eingetragenen AngabenOpen Guest
MitgliederDie Mitglieder Ihrer Organisation anlegen, lesen, ändern und entfernen und sie anmeldenEnterprise
EinbettungenEin Projekt als Live-Karte auf Ihrer Website zeigenEnterprise
WebhooksEine signierte Nachricht auf Ihrem Server erhalten, wenn etwas geschiehtOpen Guest und Enterprise

Open Guest: Besucher auf Ihrer Website messen lassen

Die Besucher Ihrer Website messen ihren Auftrag selbst, ohne Konto, sehen beim Zeichnen den Preis und senden Ihnen eine Angebotsanfrage.

So funktioniert es

  1. Sie stellen Ihren Gastlink auf Ihre Website, als Schaltfläche oder als Karte in einer Seite.
  2. Ein Besucher öffnet ihn und erhält ein eigenes Projekt, ganz ohne Registrierung.
  3. Er zeichnet seinen Rasen, sein Dach oder seine Einfahrt und sieht dabei Ihre Preise.
  4. Er klickt auf Angebot anfordern und hinterlässt Name, E-Mail-Adresse und Telefonnummer.
  5. Sie erhalten eine E-Mail und eine Benachrichtigung, und sein Projekt liegt in Ihrem Konto.

Ganz ohne Code: Kopieren Sie Ihren Gastlink oder den Code für die Schaltfläche oder die Karte unter Entwickler > Gastlink.

So funktioniert Open Guest

Aus Ihrem eigenen Anfrageformular

Damit die Angaben des Besuchers schon ausgefüllt sind, fordert Ihr Server mit Ihrem Live-Schlüssel ein Token an und schickt den Besucher zu einem neuen Gastprojekt. Der Schlüssel gelangt nie in den 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');
}

Die Entwicklerseite hält diesen Code für Ihr Konto bereit, unter Gastlink > Open-Guest-API. Jedes Gastprojekt zählt zu Ihrer Open-Guest-Nutzung.

Enterprise: Ihre Mitglieder, aus Ihrer eigenen Software

Legen Sie die Personen Ihrer Organisation aus Ihrem eigenen System an, geben Sie ihnen Projekte und schicken Sie sie bereits angemeldet in Measure Map Online.

Mitglieder anlegen

Laden Sie Personen über das Dashboard ein oder legen Sie sie über die API an. Jedes Mitglied belegt einen Platz und erhält die Standardrolle Ihrer Organisation.

POST /users/new

Mit Ihren Datensätzen verknüpfen

Speichern Sie die Benutzer-ID (uid) jedes Mitglieds beim Kunden oder Mitarbeiter in Ihrer Datenbank und rufen Sie seine Angaben ab, wenn Sie sie brauchen.

GET /users/{uid}

Projekte für sie anlegen

Legen Sie ein Projekt im Konto eines Mitglieds an und speichern Sie seine ID beim Auftrag in Ihrem eigenen System.

POST /users/{uid}/projects/new

Mitglieder anmelden

Fordern Sie ein Anmelde-Token an und schicken Sie das Mitglied damit in die App, sodass Sie nie Passwörter herausgeben müssen. Nicht verfügbar für Administratoren und Manager oder mit einem Sandbox-Schlüssel.

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

iFrame-API: eine Live-Karte auf Ihrer Website

Zeigen Sie die Karte eines Projekts mit Ihren Messungen in Ihrer eigenen Webseite oder Ihrem CRM. Besucher können sich ohne Konto darauf bewegen. Wählen Sie die Einheiten, den Kartentyp und ein helles oder dunkles Design.

Die Entwicklerseite erstellt den Code für Sie: Wählen Sie ein Projekt, prüfen Sie die Live-Vorschau und kopieren Sie den Code. Einbettungen gehören zum Enterprise-Tarif; mit Open Guest betten Sie stattdessen Ihren Gastlink ein.

Anleitung zur 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="Messungen des Auftrags">
</iframe>

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

Beispiel: ein Projekt in Ihrer eigenen Seite

Webhooks: von Änderungen erfahren

Tragen Sie auf der Entwicklerseite die Adresse Ihres Servers ein und wählen Sie die gewünschten Ereignisse. Jedes Ereignis kommt als POST mit einem JSON-Body an, signiert im Header X-MMO-Signature, damit Sie prüfen können, dass es von uns stammt.

Webhooks gehören zu den Tarifen Open Guest und Enterprise.

Anleitung zu Webhooks
Ereignis Wann gesendet
project.createdEin Projekt wird erstellt: in der App, über die API oder aus einer Einbettung
project.deletedEin Projekt wird endgültig gelöscht (das Verschieben in den Papierkorb zählt nicht)
project.comment.addedJemand kommentiert ein Projekt
guest.project.createdEin Besucher beginnt ein Gastprojekt, und seine E-Mail-Adresse ist bekannt, zum Beispiel aus Ihrem Anfrageformular (Open Guest)
guest.measurement.completedEin Besucher ist mit dem Messen fertig und hinterlässt seine Kontaktdaten (Open Guest)
budget.warning_reached,
budget.limit_reached
Ihre Open-Guest-Ausgaben erreichen Ihre Warnschwelle oder Ihr Limit
enterprise.user.createdIhrer Organisation wird ein Platz hinzugefügt, auch per Single Sign-on (Enterprise)