Measure Map Online para programadores
Deixe os visitantes medir no seu site, crie projetos para os seus clientes, leia as medições deles e saiba das alterações no momento em que acontecem. A API REST faz parte dos planos Open Guest e Enterprise.
API REST
Escolha o seu plano
A página Developer está disponível nos planos Open Guest e Enterprise. O Open Guest serve para receber pedidos de orçamento a partir do seu site; o Enterprise, para gerir uma equipa, com membros que administra através da API.
Comparar planosCrie uma chave de API
Na página Developer, crie uma chave de Produção para os seus projetos reais e uma de Testes para desenvolver e testar: os projetos de testes ficam à parte e os projetos de convidado de testes nunca são faturados. Dê a cada chave apenas o acesso de que precisa e limite-a aos seus sites.
Sobre as chaves de APIEnvie-a em cada pedido
Todos os pedidos vão para https://api.measuremaponline.com/api/v2, com a sua chave no cabeçalho Authorization. Mantenha no seu servidor as chaves que podem alterar dados.
curl https://api.measuremaponline.com/api/v2/projects/PROJECT_ID \
-H "Authorization: YOUR_API_KEY"
O que pode fazer
| Área | O que o seu software pode fazer | Planos |
|---|---|---|
| Projetos e pastas | Listar, ler, criar, atualizar e eliminar; ler as medições, os comentários e o ficheiro .mmp de um projeto | Open Guest e Enterprise |
| Produtos | Ler, criar, atualizar e arquivar os produtos com que define o preço do seu trabalho | Open Guest e Enterprise |
| Projetos de convidado | Iniciar um projeto de convidado para um visitante, com os dados dele já preenchidos | Open Guest |
| Membros | Criar, ler, atualizar e remover membros da sua organização, e fazê-los entrar com a sessão já iniciada | Enterprise |
| Mapas incorporados | Mostrar um projeto como mapa ao vivo no seu site | Enterprise |
| Webhooks | Receber uma mensagem assinada no seu servidor quando algo acontece | Open Guest e Enterprise |
Open Guest: deixe os visitantes medir no seu site
Os visitantes do seu site medem o próprio trabalho, sem conta, veem o preço enquanto desenham e enviam-lhe um pedido de orçamento.
Como funciona
- Coloca a sua ligação de convidado no seu site, como botão ou como mapa dentro de uma página.
- Um visitante abre-a e recebe um projeto próprio, sem ter de se registar.
- Desenha o relvado, o telhado ou a entrada da garagem e vê os seus preços à medida que avança.
- Prime Pedir orçamento e deixa o nome, o e-mail e o telefone.
- Recebe um e-mail e uma notificação, e o projeto dele fica na sua conta.
Não é preciso programar: copie a sua ligação de convidado, ou o código do botão ou do mapa, em Developer > Ligação de convidado.
Como funciona o Open GuestA partir do seu próprio formulário de orçamento
Para preencher os dados do visitante por ele, o seu servidor pede um token com a sua chave de produção e envia o visitante para um novo projeto de convidado. A chave nunca chega ao 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');
}
A página Developer tem este código pronto para a sua conta, em Ligação de convidado > API Open Guest. Cada projeto de convidado conta para a sua utilização do Open Guest.
Enterprise: os seus membros, a partir do seu próprio software
Registe as pessoas da sua organização a partir do seu próprio sistema, atribua-lhes projetos e envie-as para o Measure Map Online com a sessão já iniciada.
Crie membros
Convide pessoas a partir do painel ou crie-as com a API. Cada membro ocupa um lugar e recebe a função predefinida da sua organização.
POST /users/newAssocie-os aos seus registos
Guarde o ID de utilizador de cada membro (uid) com o cliente ou funcionário na sua base de dados e consulte os dados dele quando precisar.
GET /users/{uid}Crie os projetos deles
Crie um projeto na conta de um membro e guarde o respetivo ID com o trabalho no seu próprio sistema.
POST /users/{uid}/projects/newInicie-lhes a sessão
Peça um token de início de sessão e envie o membro para a aplicação com ele, para nunca ter de distribuir palavras-passe. Não disponível para administradores e gestores, nem com uma chave de testes.
POST /auth/{uid}/login
https://app.measuremaponline.com/dashboard?sit=TOKENAPI iFrame: um mapa ao vivo no seu site
Mostre o mapa de um projeto, com as suas medições, dentro da sua própria página web ou do seu CRM. Os visitantes podem explorá-lo sem conta. Escolha as unidades, o tipo de mapa e um aspeto claro ou escuro.
A página Developer gera o código por si: escolha um projeto, verifique a pré-visualização ao vivo e copie-o. Os mapas incorporados fazem parte do plano Enterprise; no Open Guest, incorpore antes a sua ligação de convidado.
Guia da API iFrame<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="Medições do trabalho">
</iframe>
ms: metric ou imperial
· maptype: satellite, map, hybrid ou terrain
· theme: auto, light ou dark
Webhooks: saiba das alterações
Adicione o endereço do seu servidor na página Developer e escolha os eventos que pretende. Cada evento chega como um POST com um corpo JSON, assinado no cabeçalho X-MMO-Signature para que possa confirmar que vem de nós.
Os webhooks fazem parte dos planos Open Guest e Enterprise.
Guia de webhooks| Evento | Enviado quando |
|---|---|
project.created | É criado um projeto, na aplicação, através da API ou a partir de um mapa incorporado |
project.deleted | Um projeto é eliminado definitivamente (movê-lo para a Reciclagem não conta) |
project.comment.added | Alguém comenta num projeto |
guest.project.created | Um visitante inicia um projeto de convidado e o e-mail dele é conhecido, por exemplo através do seu formulário de orçamento (Open Guest) |
guest.measurement.completed | Um visitante termina de medir e deixa os seus contactos (Open Guest) |
budget.warning_reached,budget.limit_reached | Os seus gastos Open Guest atingem o seu limiar de aviso ou o seu limite |
enterprise.user.created | É adicionado um lugar à sua organização, incluindo através de início de sessão único (Enterprise) |