iFrame API
Vis et av prosjektene dine som et levende kart på ditt eget nettsted, med enhetene, kartstilen og temaet som passer nettstedet ditt.
iFrame API-et setter et prosjekts kart på din egen nettside. Besøkende ser satellittkartet med målingene dine og kan bevege seg rundt i det, uten konto og uten å forlate nettstedet ditt. Du velger prosjektet, enhetene, kartstilen og fargetemaet.
Før du begynner#
- En live API-nøkkel med tilgangen Innebygde kart. Se API-nøkler.
- Et prosjekt besøkende kan se: ditt eget eller en annen kontos, delt som Bare visning eller Offentlig. Et Privat prosjekt vises bare hvis det tilhører en annen konto og eieren har autorisert deg (se kunders private prosjekter); dine egne private prosjekter vises aldri. Se hvilke prosjekter som kan bygges inn.
- Eventuelt nettstedsbegrensninger på nøkkelen, så innbyggingen bare fungerer på dine egne nettsteder. Se API-nøkler.
Bygg innbyggingskoden#
Utvikler > Bygg inn et kart bygger koden for deg med live-nøkkelen din: velg prosjektet, velg tema, enheter, karttype og størrelse, sjekk Live forhåndsvisning, og kopier Innbyggingskode. Hvis prosjektet er privat, sier delen det og tilbyr Gjør det skrivebeskyttet. Se hent innbyggingskoden for hvert trinn.
Koden inneholder nøkkelen din, så den fortsetter å fungere til du bytter nøkkelen. Delen advarer deg når nøkkelen kan mer enn Innebygde kart, siden hvem som helst kan lese den i kilden til siden din, og når nøkkelen ikke har noen nettstedsbegrensninger. Bare Live forhåndsvisning bruker et token med kort levetid. Se nøkkel eller token.
Innbyggingsadressen#
En innbygging er en <iframe> med en adresse som starter med
https://app.measuremaponline.com/iframe_api, etterfulgt av disse
parameterne:
| Parameter | Nødvendig | Verdier |
|---|---|---|
pid |
påkrevd | Prosjektets ID: delen etter /p/ i prosjektets adresse i appen. Eieren kan kopiere den nederst i prosjektets oversikt, og et klikk på prosjektets navn i et innebygd kart kopierer den også. |
key |
key eller token |
API-nøkkelen din. |
token |
key eller token |
Et token fra serveren din (se nedenfor). |
ms |
valgfri | Enheter: metric eller imperial. Uten den ser besøkende i USA imperiale enheter og alle andre metriske. |
maptype |
valgfri | satellite (standard), map, hybrid eller terrain. |
theme |
valgfri | auto (standard: følger den besøkendes eget systemvalg), light eller dark. |
Et minimalt eksempel#
<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>
Bytt ut YOUR_PROJECT_ID, YOUR_API_KEY og YOUR_PROJECT_NAME (skjermlesere
leser opp title), og sett bredde og høyde slik at de passer siden din.
Nøkkel eller token#
Med key, som i koden delen Bygg inn et kart gir deg, fortsetter
innbyggingen å fungere så lenge nøkkelen gjør det, på nettstedene
begrensningene tillater. Nøkkelen din er da synlig i kilden til siden din, så:
- bruk en nøkkel med bare tilgangen Innebygde kart;
- begrens den til dine egne nettsteder;
- når du bytter nøkkelen, oppdaterer du sidene dine innen de 24 timene den gamle nøkkelen fortsetter å fungere (en nøkkel laget før nøkler hadde tilgangsinnstillinger beholder datoen du fikk oppgitt).
Med token blir nøkkelen på serveren din. Det passer for innbygginger
som din egen server skriver inn på siden for hvert besøk: før den viser siden,
ber den REST API-et om et token og setter det i iframe-ens adresse:
POST https://api.measuremaponline.com/api/v2/auth/iframe/token, med nøkkelen din iAuthorization-headeren, returnerer ettokensom fungerer i 60 minutter;POST https://api.measuremaponline.com/api/v2/auth/tokengjør det samme og godtar endurationi sekunder, opptil 24 timer. Svaret sier når tokenet utløper.
Kontoen din kan få opptil 600 tokens i timen. Bruk en live-nøkkel: innbygginger viser bare live-prosjekter, så et token laget med en sandbox-nøkkel åpner ikke et kart. Se API-referansen.
Hva besøkende kan gjøre#
Besøkende kan panorere og zoome kartet, lese målingene til figurene dine og lese prosjektets kommentarer. De kan legge til kommentarer når prosjektet lar alle kommentere, og å klikke på prosjektets navn kopierer ID-en. De kan ikke endre noe annet: redigering er slått av i en innbygging, uansett prosjektets tilgangsnivå. Det eneste unntaket er et Open Guest-prosjekt på Open Guest-planen, der besøkende måler for seg selv.
Når kartet ikke vises#
I de fleste tilfeller viser kartet en melding om hvorfor: se når kartet viser en melding. Sjekk, i denne rekkefølgen:
- Adressen har et
tokensom er utløpt. Tokens varer i 60 minutter med mindre serveren din ba om lengre. Kopier koden på nytt fra Bygg inn et kart, som bruker nøkkelen din, eller la serveren din hente et nytt token for hvert besøk (se ovenfor). - Prosjektet er privat. Hvis det er ditt, setter du det til Bare visning eller Offentlig, eller trykker Gjør det skrivebeskyttet i Bygg inn et kart. Hvis det tilhører en kunde, kan de autorisere deg fra kartet, eller du kan spørre dem i Private prosjekter.
- Prosjektets plan er avsluttet: eierens plan, eller for en organisasjons prosjekt, organisasjonens. Det vises igjen når planen fornyes.
- Nettstedet er ikke tillatt. Hvis nøkkelen har nettstedsbegrensninger, må siden som viser innbyggingen være på et av dem. Noen nettlesere og nettsteder skjuler hvilken side en innbygging er på; med begrensninger satt, nektes en slik innbygging.
- Nøkkelen ble byttet ut. En gammel nøkkel slutter å fungere 24 timer etter at en ny er opprettet, eller med en gang hvis den ble tilbakekalt.
- Nøkkelen er en sandbox-nøkkel. Innbygginger fungerer bare med live-nøkler og live-prosjekter.
- Abonnementet er ikke aktivt, eller API-tilgangen er suspendert: delen API-nøkler sier det.
Trenger du mer hjelp?
Skriv til brukerstøtten og fortell hva du prøvde å gjøre. Skjermbilder hjelper.