API d'iFrame · Ajuda de Measure Map Online

Mostra un dels teus projectes com a mapa en directe al teu propi lloc web, amb les unitats, l'estil de mapa i el tema que més convinguin al teu lloc.

L'API d'iFrame posa el mapa d'un projecte a la teva pròpia pàgina web. Els visitants veuen el mapa de satèl·lit amb les teves mesures i s'hi poden moure, sense compte i sense sortir del teu lloc. Tries el projecte, les unitats, l'estil de mapa i el tema de colors.

Abans de començar#

Una clau d'API real amb accés Mapes incrustats. Consulta claus d'API.
Un projecte que els visitants puguin veure: teu o d'un altre compte, compartit com a Només lectura o Públic. Un projecte Privat només es mostra si és d'un altre compte i el seu propietari t'ha autoritzat (consulta projectes privats dels clients); els teus propis projectes privats no es mostren mai. Consulta quins projectes es poden incrustar.
Opcionalment, restriccions de llocs web a la clau, perquè l'incrustat només funcioni als teus propis llocs. Consulta claus d'API.

Crea el codi d'incrustació#

Desenvolupador > Incrusta un mapa et crea el codi amb la teva clau real: tria el projecte, tria el tema, les unitats, el tipus de mapa i la mida, comprova la Vista prèvia en directe i copia el Codi d'incrustació. Si el projecte és privat, la secció ho diu i ofereix Fes-lo només de visualització. Consulta obtén el codi d'incrustació per a cada pas.

Incrusta un mapa amb un projecte triat i la previsualització en directe

El codi porta la teva clau, de manera que continua funcionant fins que substitueixes la clau. La secció t'avisa quan la clau pot fer més que Mapes incrustats, ja que qualsevol pot llegir-la al codi font de la teva pàgina, i quan la clau no té restriccions de llocs web. Només la Vista prèvia en directe fa servir un token de curta durada. Consulta clau o token.

L'adreça de l'incrustat#

Un incrustat és un <iframe> l'adreça del qual comença per https://app.measuremaponline.com/iframe_api, seguida d'aquests paràmetres:

Paràmetre	Necessari	Valors
`pid`	obligatori	L'ID del projecte: la part després de `/p/` a l'adreça del projecte a l'aplicació. El seu propietari el pot copiar al final de la visió general del projecte, i fer clic al nom del projecte en un mapa incrustat també el copia.
`key`	`key` o `token`	La teva clau d'API.
`token`	`key` o `token`	Un token del teu servidor (vegeu més avall).
`ms`	opcional	Unitats: `metric` o `imperial`. Sense aquest paràmetre, els visitants dels Estats Units veuen unitats imperials i tots els altres mètriques.
`maptype`	opcional	`satellite` (el valor per defecte), `map`, `hybrid` o `terrain`.
`theme`	opcional	`auto` (el valor per defecte: segueix la configuració del sistema del mateix visitant), `light` o `dark`.

Un exemple mínim#

<iframe src="https://app.measuremaponline.com/iframe_api?pid=YOUR_PROJECT_ID&key=YOUR_API_KEY&maptype=satellite&theme=auto"
  title="YOUR_PROJECT_NAME" width="500" height="500" style="border:0" allow="fullscreen"></iframe>

Substitueix YOUR_PROJECT_ID, YOUR_API_KEY i YOUR_PROJECT_NAME (els lectors de pantalla llegeixen el title en veu alta), i ajusta l'amplada i l'alçada a la teva pàgina.

El codi d'incrustació amb el botó de copiar

Clau o token#

Amb key, com al codi que et dona la secció Incrusta un mapa, l'incrustat continua funcionant mentre funcioni la clau, als llocs web que permetin les seves restriccions. Aleshores la teva clau és visible al codi font de la pàgina, així que:

fes servir una clau només amb accés Mapes incrustats;
restringeix-la als teus propis llocs web;
quan substitueixis la clau, actualitza les pàgines dins de les 24 hores que la clau antiga continua funcionant (una clau feta abans que les claus tinguessin configuració d'accés conserva la data que se't va donar).

Amb token, la clau es queda al teu servidor. Això va bé per als incrustats que el teu propi servidor escriu a la pàgina a cada visita: abans de mostrar la pàgina, demana un token a l'API REST i el posa a l'adreça de l'iframe:

POST https://api.measuremaponline.com/api/v2/auth/iframe/token, amb la teva clau a la capçalera Authorization, retorna un token que funciona durant 60 minuts;
POST https://api.measuremaponline.com/api/v2/auth/token fa el mateix i accepta una duration en segons, fins a 24 hores. La resposta diu quan caduca el token.

El teu compte pot obtenir fins a 600 tokens per hora. Fes servir una clau real: els incrustats només mostren projectes reals, de manera que un token fet amb una clau sandbox no obre cap mapa. Consulta la referència de l'API.

Què poden fer els visitants#

Els visitants poden desplaçar i ampliar el mapa, llegir les mesures de les teves figures i llegir els comentaris del projecte. Hi poden afegir comentaris quan el projecte deixa comentar a tothom, i fer clic al nom del projecte en copia l'ID. No poden canviar res més: l'edició està desactivada dins d'un incrustat, sigui quin sigui el nivell d'accés del projecte. L'única excepció és un projecte Open Guest al pla Open Guest, on els visitants mesuren per ells mateixos.

Quan el mapa no apareix#

En la majoria dels casos el mapa mostra un missatge que diu per què: consulta quan el mapa mostra un missatge. Comprova, per ordre:

L'adreça té un token que ha caducat. Els tokens duren 60 minuts tret que el teu servidor n'hagi demanat més. Torna a copiar el codi de Incrusta un mapa, que fa servir la teva clau, o fes que el teu servidor obtingui un token nou a cada visita (vegeu més amunt).
El projecte és privat. Si és teu, posa'l a Només lectura o Públic, o prem Fes-lo només de visualització a Incrusta un mapa. Si és d'un client, et pot autoritzar des del mapa, o li ho pots demanar a Projectes privats.
El pla del projecte ha acabat: el pla del seu propietari o, per al projecte d'una organització, el de l'organització. Es torna a mostrar quan es renova el pla.
El lloc web no està permès. Si la clau té restriccions de llocs web, la pàgina que mostra l'incrustat ha de ser en una d'aquestes. Alguns navegadors i llocs amaguen en quina pàgina és un incrustat; amb restriccions definides, aquest incrustat es rebutja.
La clau s'ha substituït. Una clau antiga s'atura 24 hores després que se'n creï una de nova, o a l'instant si s'ha revocat.
La clau és una clau sandbox. Els incrustats només funcionen amb claus reals i projectes reals.
La subscripció no és activa, o l'accés a l'API s'ha suspès: la secció Claus d'API ho diu.