API-ul iFrame
Afișează unul dintre proiectele tale ca hartă live pe propriul site, în unitățile, stilul de hartă și tema potrivite site-ului tău.
API-ul iFrame afișează harta unui proiect pe propria ta pagină web. Vizitatorii văd harta satelit cu măsurătorile tale și se pot deplasa pe ea, fără cont și fără să părăsească site-ul tău. Tu alegi proiectul, unitățile, stilul hărții și tema de culori.
Înainte de a începe#
- O cheie API live cu acces Hărți încorporate. Vezi cheile API.
- Un proiect pe care vizitatorii au voie să-l vadă: al tău sau al altui cont, partajat ca Doar vizualizare sau Public. Un proiect Privat se afișează doar dacă este al altui cont și proprietarul lui te-a autorizat (vezi proiectele private ale clienților); proiectele tale private nu se afișează niciodată. Vezi ce proiecte pot fi încorporate.
- Opțional, restricții de site pe cheie, ca încorporarea să funcționeze doar pe site-urile tale. Vezi cheile API.
Construiește codul de încorporare#
Dezvoltator > Încorporează o hartă construiește codul pentru tine cu cheia ta live: alege proiectul, tema, unitățile, tipul hărții și dimensiunea, verifică Previzualizare în direct și copiază Cod de încorporare. Dacă proiectul este privat, secțiunea spune asta și oferă Setează doar vizualizare. Vezi obține codul de încorporare pentru fiecare pas.
Codul conține cheia ta, așa că funcționează până când înlocuiești cheia. Secțiunea te avertizează când cheia poate face mai mult decât Hărți încorporate, deoarece oricine o poate citi în sursa paginii tale, și când cheia nu are restricții de site. Doar Previzualizare în direct folosește un token de scurtă durată. Vezi cheie sau token.
Adresa de încorporare#
O încorporare este un <iframe> a cărui adresă începe cu
https://app.measuremaponline.com/iframe_api, urmată de acești parametri:
| Parametru | Necesar | Valori |
|---|---|---|
pid |
obligatoriu | ID-ul proiectului: partea de după /p/ din adresa proiectului în aplicație. Proprietarul îl poate copia la sfârșitul prezentării generale a proiectului, iar un clic pe numele proiectului într-o hartă încorporată îl copiază și el. |
key |
key sau token |
Cheia ta API. |
token |
key sau token |
Un token de la serverul tău (vezi mai jos). |
ms |
opțional | Unități: metric sau imperial. Fără el, vizitatorii din Statele Unite văd unități imperiale, iar ceilalți unități metrice. |
maptype |
opțional | satellite (implicit), map, hybrid sau terrain. |
theme |
opțional | auto (implicit: urmează setarea de sistem a vizitatorului), light sau dark. |
Un exemplu minim#
<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>
Înlocuiește YOUR_PROJECT_ID, YOUR_API_KEY și YOUR_PROJECT_NAME (cititoarele
de ecran citesc title cu voce tare) și setează lățimea și înălțimea potrivit
paginii tale.
Cheie sau token#
Cu key, ca în codul pe care ți-l oferă secțiunea
Încorporează o hartă, încorporarea funcționează cât timp funcționează
cheia, pe site-urile permise de restricțiile ei. Cheia ta este atunci vizibilă
în sursa paginii, deci:
- folosește o cheie cu acces doar Hărți încorporate;
- restricționeaz-o la propriile tale site-uri;
- când înlocuiești cheia, actualizează-ți paginile în cele 24 de ore cât cheia veche continuă să funcționeze (o cheie creată înainte de setările de acces o ține până la data care ți-a fost comunicată).
Cu token, cheia rămâne pe serverul tău. Se potrivește încorporărilor pe
care propriul tău server le scrie în pagină la fiecare vizită: înainte de a
afișa pagina, cere API-ului REST un token și îl pune în adresa iframe-ului:
POST https://api.measuremaponline.com/api/v2/auth/iframe/token, cu cheia ta în antetulAuthorization, returnează untokenvalabil 60 de minute;POST https://api.measuremaponline.com/api/v2/auth/tokenface același lucru și acceptă odurationîn secunde, până la 24 de ore. Răspunsul lui spune când expiră tokenul.
Contul tău poate obține până la 600 de tokenuri pe oră. Folosește o cheie live: încorporările afișează doar proiecte live, așa că un token creat cu o cheie sandbox nu deschide o hartă. Vezi referința API.
Ce pot face vizitatorii#
Vizitatorii pot deplasa și mări harta, pot citi măsurătorile formelor tale și pot citi comentariile proiectului. Pot adăuga comentarii când proiectul permite tuturor să comenteze, iar un clic pe numele proiectului îi copiază ID-ul. Nu pot schimba nimic altceva: editarea este dezactivată într-o încorporare, indiferent de nivelul de acces al proiectului. Singura excepție este un proiect Open Guest pe planul Open Guest, unde vizitatorii măsoară pentru ei înșiși.
Când harta nu apare#
În cele mai multe cazuri harta afișează un mesaj care spune de ce: vezi când harta afișează un mesaj. Verifică, în ordine:
- Adresa conține un
tokenexpirat. Tokenurile durează 60 de minute, dacă serverul tău nu a cerut mai mult. Copiază din nou codul din Încorporează o hartă, care folosește cheia ta, sau pune serverul să obțină un token nou la fiecare vizită (vezi mai sus). - Proiectul este privat. Dacă este al tău, setează-l la Doar vizualizare sau Public ori apasă Setează doar vizualizare în Încorporează o hartă. Dacă este al unui client, acesta te poate autoriza din hartă sau îl poți ruga în Proiecte private.
- Planul proiectului a expirat: planul proprietarului sau, pentru proiectul unei organizații, planul organizației. Proiectul se afișează din nou după reînnoirea planului.
- Site-ul nu este permis. Dacă cheia are restricții de site, pagina care afișează încorporarea trebuie să fie pe unul dintre ele. Unele browsere și site-uri ascund pe ce pagină se află o încorporare; cu restricții setate, o astfel de încorporare este refuzată.
- Cheia a fost înlocuită. O cheie veche se oprește la 24 de ore după crearea uneia noi sau imediat, dacă a fost revocată.
- Cheia este o cheie sandbox. Încorporările funcționează doar cu chei live și proiecte live.
- Abonamentul nu este activ sau accesul la API a fost suspendat: secțiunea Chei API spune asta.
Mai ai nevoie de ajutor?
Scrie echipei noastre de suport și spune-ne ce încercai să faci. Capturile de ecran ajută.