API iFrame · Ayuda de Measure Map Online

Muestra uno de tus proyectos como mapa en vivo en tu propio sitio web, con las unidades, el estilo de mapa y el tema que encajen con tu sitio.

La API iFrame pone el mapa de un proyecto en tu propia página web. Los visitantes ven el mapa de satélite con tus mediciones y pueden moverse por él, sin cuenta y sin salir de tu sitio. Tú eliges el proyecto, las unidades, el estilo del mapa y el tema de color.

Antes de empezar#

Una clave de API de producción con acceso Mapas incrustados. Consulta claves de API.
Un proyecto que los visitantes puedan ver. Pon su nivel de acceso en Ver sólo o Público. Un proyecto Privado no se abre para los visitantes sin cuenta. Consulta qué proyectos se pueden incrustar.
Si quieres, restricciones de sitios web en la clave, para que el mapa incrustado solo funcione en tus propios sitios. Consulta claves de API.

Generar el código de inserción#

Desarrollador > Insertar un mapa genera el código por ti con tu clave de producción: elige el proyecto, el tema, las unidades, el tipo de mapa y el tamaño, comprueba la Vista previa en vivo y copia el Código de inserción. Si el proyecto es privado, la sección lo indica y ofrece Cambiar a «Ver sólo». Consulta obtener el código de inserción para cada paso.

Insertar un mapa con un proyecto elegido y la vista previa en vivo

El código lleva tu clave, así que sigue funcionando hasta que sustituyas la clave. La sección te avisa cuando la clave puede hacer algo más que Mapas incrustados, ya que cualquiera puede leerla en el código fuente de tu página, y cuando la clave no tiene restricciones de sitios web. Solo la Vista previa en vivo usa un token de corta duración. Consulta clave o token.

La dirección de inserción#

Un mapa incrustado es un <iframe> cuya dirección empieza por https://app.measuremaponline.com/iframe_api, seguida de estos parámetros:

Parámetro	Necesario	Valores
`pid`	obligatorio	El identificador del proyecto: la parte que va después de `/p/` en la dirección del proyecto en la aplicación.
`key`	`key` o `token`	Tu clave de API.
`token`	`key` o `token`	Un token de tu servidor (ver más abajo).
`ms`	opcional	Unidades: `metric` o `imperial`. Sin él, los visitantes de Estados Unidos ven unidades imperiales y todos los demás, métricas.
`maptype`	opcional	`satellite` (el predeterminado), `map`, `hybrid` o `terrain`.
`theme`	opcional	`auto` (el predeterminado: sigue la opción del sistema del propio visitante), `light` o `dark`.

Un ejemplo mínimo#

<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>

Sustituye YOUR_PROJECT_ID, YOUR_API_KEY y YOUR_PROJECT_NAME (los lectores de pantalla leen el title en voz alta), y ajusta el ancho y el alto a tu página.

El código de inserción con su botón de copiar

Clave o token#

Con key, como en el código que te da la sección Insertar un mapa, el mapa incrustado sigue funcionando mientras funcione la clave, en los sitios web que permitan sus restricciones. Tu clave queda entonces visible en el código fuente de tu página, así que:

usa una clave que solo tenga acceso Mapas incrustados;
restríngela a tus propios sitios web;
cuando sustituyas la clave, actualiza tus páginas dentro de las 24 horas en las que la clave antigua sigue funcionando.

Con token, la clave se queda en tu servidor. Esto sirve para mapas incrustados que tu propio servidor escribe en la página en cada visita: antes de mostrar la página, pide un token a la API REST y lo pone en la dirección del iframe:

POST https://api.measuremaponline.com/api/v2/auth/iframe/token, con tu clave en la cabecera Authorization, devuelve un token que funciona durante 60 minutos;
POST https://api.measuremaponline.com/api/v2/auth/token hace lo mismo y admite una duración (duration) en segundos, de hasta 24 horas. Su respuesta indica cuándo caduca el token.

Tu cuenta puede obtener hasta 600 tokens por hora. Usa una clave de producción: los mapas incrustados solo muestran proyectos de producción, así que un token creado con una clave de pruebas no abre ningún mapa. Consulta la referencia de la API.

Qué pueden hacer los visitantes#

Los visitantes pueden desplazar y acercar el mapa y consultar las mediciones de tus figuras. No pueden cambiar nada: la edición está desactivada dentro de un mapa incrustado, sea cual sea el nivel de acceso del proyecto. La única excepción es un proyecto Open Guest en el plan Open Guest, donde los visitantes miden por su cuenta.

Cuando el mapa no aparece#

Comprueba, por este orden:

La dirección lleva un token que ha caducado. Los tokens duran 60 minutos salvo que tu servidor pidiera más. Vuelve a copiar el código de Insertar un mapa, que usa tu clave, o haz que tu servidor obtenga un token nuevo en cada visita (ver más arriba).
El proyecto es privado. Ponlo en Ver sólo o Público, o pulsa Cambiar a «Ver sólo» en Insertar un mapa.
El sitio web no está permitido. Si la clave tiene restricciones de sitios web, la página que muestra el mapa incrustado tiene que estar en uno de ellos. Algunos navegadores y sitios ocultan en qué página está un mapa incrustado; con restricciones definidas, ese mapa se rechaza.
La clave se ha sustituido. Una clave antigua deja de funcionar 24 horas después de crear una nueva, o al momento si se revocó.
La clave es de pruebas. Los mapas incrustados solo funcionan con claves de producción y proyectos de producción.
La suscripción no está activa, o se ha suspendido el acceso a la API: la sección Claves de API lo indica.