iFrame API · Pomoc Measure Map Online

Pokaż jeden ze swoich projektów jako działającą mapę na własnej stronie, w jednostkach, stylu mapy i motywie, które pasują do Twojej witryny.

iFrame API umieszcza mapę projektu na Twojej własnej stronie internetowej. Odwiedzający widzą mapę satelitarną z Twoimi pomiarami i mogą się po niej poruszać, bez konta i bez opuszczania Twojej witryny. Ty wybierasz projekt, jednostki, styl mapy i motyw kolorystyczny.

Zanim zaczniesz#

Klucz API live z dostępem Osadzone mapy. Zobacz klucze API.
Projekt, który odwiedzający mogą zobaczyć: Twój lub z innego konta, udostępniony jako Tylko podgląd lub Publiczny. Projekt Prywatny wyświetla się tylko wtedy, gdy należy do innego konta, a jego właściciel Cię upoważnił (zobacz prywatne projekty klientów); Twoje własne prywatne projekty nigdy się nie wyświetlają. Zobacz które projekty można osadzić.
Opcjonalnie ograniczenia stron dla klucza, aby osadzenie działało tylko na Twoich własnych stronach. Zobacz klucze API.

Zbuduj kod osadzenia#

Deweloper > Osadź mapę buduje kod za Ciebie z Twoim kluczem live: wybierz projekt, motyw, jednostki, typ mapy i rozmiar, sprawdź Podgląd na żywo i skopiuj Kod osadzania. Jeśli projekt jest prywatny, sekcja o tym informuje i proponuje Ustaw tylko do podglądu. Zobacz pobierz kod osadzenia, aby poznać każdy krok.

Osadzanie mapy z wybranym projektem i podglądem na żywo

Kod zawiera Twój klucz, więc działa, dopóki nie wymienisz klucza. Sekcja ostrzega, gdy klucz może więcej niż Osadzone mapy, bo każdy może go odczytać w źródle Twojej strony, oraz gdy klucz nie ma ograniczeń stron. Tylko Podgląd na żywo używa krótkotrwałego tokenu. Zobacz klucz czy token.

Adres osadzenia#

Osadzenie to <iframe>, którego adres zaczyna się od https://app.measuremaponline.com/iframe_api, a dalej następują te parametry:

Parametr	Wymagany	Wartości
`pid`	wymagany	Identyfikator projektu: część po `/p/` w adresie projektu w aplikacji. Jego właściciel może go skopiować na końcu przeglądu projektu, a kliknięcie nazwy projektu w osadzonej mapie też go kopiuje.
`key`	`key` lub `token`	Twój klucz API.
`token`	`key` lub `token`	Token z Twojego serwera (zobacz niżej).
`ms`	opcjonalny	Jednostki: `metric` lub `imperial`. Bez niego odwiedzający ze Stanów Zjednoczonych widzą jednostki imperialne, a wszyscy pozostali metryczne.
`maptype`	opcjonalny	`satellite` (domyślnie), `map`, `hybrid` lub `terrain`.
`theme`	opcjonalny	`auto` (domyślnie: zgodnie z ustawieniem systemu odwiedzającego), `light` lub `dark`.

Minimalny przykład#

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

Zastąp YOUR_PROJECT_ID, YOUR_API_KEY i YOUR_PROJECT_NAME (czytniki ekranu odczytują title) i ustaw szerokość oraz wysokość tak, aby pasowały do Twojej strony.

Klucz czy token#

Z key, jak w kodzie, który daje sekcja Osadź mapę, osadzenie działa tak długo, jak klucz, na stronach, które pozwalają jego ograniczenia. Twój klucz jest wtedy widoczny w źródle strony, więc:

używaj klucza tylko z dostępem Osadzone mapy;
ogranicz go do własnych stron;
gdy wymieniasz klucz, zaktualizuj swoje strony w ciągu 24 godzin, przez które stary klucz nadal działa (klucz utworzony, zanim klucze miały ustawienia dostępu, zachowuje podaną Ci datę).

Z token klucz zostaje na Twoim serwerze. Pasuje to do osadzeń, które Twój serwer zapisuje na stronie przy każdej wizycie: przed pokazaniem strony prosi REST API o token i wstawia go w adres iframe:

POST https://api.measuremaponline.com/api/v2/auth/iframe/token, z Twoim kluczem w nagłówku Authorization, zwraca token ważny przez 60 minut;
POST https://api.measuremaponline.com/api/v2/auth/token robi to samo i przyjmuje duration w sekundach, do 24 godzin. Jego odpowiedź podaje, kiedy token wygasa.

Twoje konto może dostać do 600 tokenów na godzinę. Użyj klucza live: osadzenia pokazują tylko projekty live, więc token utworzony kluczem sandbox nie otwiera mapy. Zobacz dokumentację API.

Co mogą robić odwiedzający#

Odwiedzający mogą przesuwać i przybliżać mapę, czytać pomiary Twoich kształtów i czytać komentarze projektu. Mogą dodawać komentarze, gdy projekt pozwala komentować wszystkim, a kliknięcie nazwy projektu kopiuje jego identyfikator. Nie mogą zmieniać niczego innego: edycja jest wyłączona w osadzeniu, niezależnie od poziomu dostępu projektu. Jedynym wyjątkiem jest projekt Open Guest w planie Open Guest, w którym odwiedzający mierzą dla siebie.

Gdy mapa się nie pojawia#

W większości przypadków mapa pokazuje komunikat z przyczyną: zobacz gdy mapa pokazuje komunikat. Sprawdź po kolei:

Adres ma token, który wygasł. Tokeny ważą 60 minut, chyba że serwer poprosił o dłużej. Skopiuj kod ponownie z Osadź mapę, który używa Twojego klucza, albo niech Twój serwer pobiera świeży token przy każdej wizycie (zobacz wyżej).
Projekt jest prywatny. Jeśli jest Twój, ustaw go na Tylko podgląd lub Publiczny albo naciśnij Ustaw tylko do podglądu w Osadź mapę. Jeśli należy do klienta, może on Cię upoważnić z poziomu mapy, albo możesz poprosić go w Prywatnych projektach.
Plan projektu się skończył: plan jego właściciela, a dla projektu organizacji plan organizacji. Projekt znów się wyświetli po odnowieniu planu.
Strona nie jest dozwolona. Jeśli klucz ma ograniczenia stron, strona pokazująca osadzenie musi być jedną z nich. Niektóre przeglądarki i witryny ukrywają, na jakiej stronie jest osadzenie; przy ustawionych ograniczeniach takie osadzenie jest odrzucane.
Klucz został wymieniony. Stary klucz przestaje działać 24 godziny po utworzeniu nowego, a od razu, jeśli został unieważniony.
Klucz jest kluczem sandbox. Osadzenia działają tylko z kluczami live i projektami live.
Subskrypcja nie jest aktywna albo dostęp do API został zawieszony: informuje o tym sekcja Klucze API.