Klucze API · Pomoc Measure Map Online

Utwórz klucz łączący Twoją stronę lub oprogramowanie z Measure Map Online, wybierz, co może robić, oddziel pracę produkcyjną od testowej oraz bezpiecznie go wymień i ogranicz.

Klucz API pozwala Twojej stronie lub oprogramowaniu pracować z kontem Measure Map Online: pokazać mapę projektu na Twojej stronie, zakładać projekty dla odwiedzających albo odczytywać i zmieniać projekty przez REST API. Klucze tworzysz i zarządzasz nimi na stronie Deweloper.

Otwórz stronę Developer#

W menu panelu, w sekcji Zaawansowane, naciśnij Deweloper. Otwiera się na Klucze API, a pozostałe sekcje są wymienione pod nią w menu (na telefonie jako karty u góry strony):

Link dla gościa (Open Guest): link bez kodu dla Twojej strony. Zobacz Open Guest.
Wypróbuj API, Webhooki i REST API: zobacz dokumentację API.
Osadź mapę (Enterprise): zobacz iFrame API.
Prywatne projekty (Enterprise): pokazuj prywatne projekty klientów w swoich osadzeniach. Zobacz prywatne projekty klientów.

Plakietka u góry karty klucza mówi, czy Twój klucz jest Aktywna, Nieaktywowana (jeszcze nie ma klucza), Wyłączone (dostęp do API zawieszony: żaden klucz nie działa i nie można utworzyć nowego, dopóki pomoc techniczna tego nie zniesie) lub Wygasła (subskrypcja nie jest aktywna).

Sekcja Klucze API z kluczem Sandbox, ukrytym poza jego końcami, tym, co może robić, przyciskami do jego pokazania i skopiowania oraz przyciskiem Wygeneruj nowy klucz

Live i Sandbox#

U góry karty klucza przełączasz się między Produkcyjne a Piaskownica. Każde środowisko ma własny klucz, a strona pokazuje ten, który wybierzesz. Wybór obowiązuje także w Wypróbuj API i zostaje po przejściu między sekcjami. Osadź mapę i Link dla gościa zawsze używają klucza produkcyjnego (live), bo odwiedzający Twoją stronę mogą otwierać tylko projekty produkcyjne: otwarcie którejkolwiek z nich przełącza stronę z powrotem na Produkcyjne.

Produkcyjne to Twoje prawdziwe konto, a strona otwiera się właśnie na nim. Na swojej stronie używaj klucza live.
Piaskownica służy do budowania i testowania integracji. Projekty, foldery i produkty utworzone kluczem sandbox są oddzielone od prawdziwych: klucz live ich nie widzi, a klucz sandbox nie widzi Twoich produkcyjnych. Żądania wysłane kluczem sandbox nie są wliczane do statystyk użycia, a projekty gości utworzone takim kluczem nigdy nie są rozliczane.

Utworzenie nowego klucza sandbox nigdy nie wpływa na klucz live, i odwrotnie.

Wybierz, co klucz może robić#

Gdy tworzysz klucz, okno wymienia każdy obszar API w sekcji Dostęp dla nowego klucza. Wybierz, jak daleko nowy klucz sięga w każdym z nich:

Obszar	Możliwości	Na co pozwala
Osadzone mapy (Enterprise)	Brak dostępu, Dozwolone	Zaloguj widza do osadzonej mapy. Większość integracji potrzebuje tylko tego.
Projekty gości (Open Guest)	Brak dostępu, Dozwolone	Rozpocznij projekt gościa dla odwiedzającego, z tokenem z Twojego serwera. Większość integracji potrzebuje tylko tego.
Projekty	Brak dostępu, Odczyt, Odczyt i zmiany	Projekty i foldery wraz z pomiarami, komentarzami i eksportami.
Użytkownicy (Enterprise)	Brak dostępu, Odczyt, Odczyt i zmiany	Użytkownicy Twojej organizacji, ich zaproszenia, licencje i zespoły.
Organizacja (Enterprise)	Brak dostępu, Odczyt, Odczyt i zmiany	Profil, zasady, logowanie jednokrotne i dziennik aktywności Twojej organizacji oraz jej licencje.
Produkty	Brak dostępu, Odczyt, Odczyt i zmiany	Katalog Twoich produktów i ich ceny.
Goście (Open Guest)	Brak dostępu, Odczyt, Odczyt i zmiany	Twój link dla gościa, projekty gości i prośby o wycenę, z danymi kontaktowymi Twoich gości, oraz Twój budżet.
Konto	Brak dostępu, Odczyt, Odczyt i zmiany	Twój plan, licencje, użycie API, profil i ustawienia e-mail, a w Open Guest Twoje wydatki i budżet.
Deweloper	Brak dostępu, Odczyt, Odczyt i zmiany	Twoje klucze API i webhook. Klucz nigdy nie wykracza poza własny dostęp.
Klienci (Partner)	Brak dostępu, Odczyt, Odczyt i zmiany	Twoi klienci, plany, za które płacisz, ich zaproszenia i faktury.

Okno pokazuje tylko obszary, które obejmuje Twój plan. Zatrzymaj wskaźnik myszy na wyborze, aby zobaczyć dokładnie, co daje. Pierwszy klucz zaczyna się od samego Osadzone mapy, czyli tego, czego potrzebuje osadzona mapa; klucz, który zastępuje inny, zaczyna się od dostępu tamtego klucza. Wybierz co najmniej jeden obszar.

To, co klucz może robić, jest ustalane w chwili jego utworzenia. Aby dać kluczowi większy lub mniejszy dostęp, utwórz nowy.

Utwórz klucz#

U góry karty klucza wybierz Produkcyjne lub Piaskownica.
Naciśnij Wygeneruj nowy klucz. Otwiera się okno, z Produkcyjne lub Piaskownica obok tytułu.
Ustaw dostęp w sekcji Dostęp dla nowego klucza (zobacz wyżej).
Jeśli chcesz, wpisz nazwę w polu Nazwa nowego klucza (opcjonalnie), aby odróżniać swoje klucze.
Naciśnij Utwórz.

Okno Wygeneruj nowy klucz: środowisko Live, dostęp do każdego obszaru API i nazwa klucza

Następnie okno mówi Twój nowy klucz jest gotowy. Możesz go skopiować ponownie z tej strony w dowolnej chwili. Pokazuje klucz, ukryty poza pierwszymi i ostatnimi znakami, oraz to, co klucz Może. Naciśnij , aby pokazać go w całości, lub , aby skopiować cały klucz, a potem naciśnij Gotowe. Karta klucza pokazuje go w ten sam sposób w sekcji Twój klucz API. Za każdym razem, gdy na Twoim koncie powstaje klucz, dostajesz e-mail.

Klucze utworzone przed ustawieniami dostępu#

Klucz utworzony, zanim klucze miały ustawienia dostępu, może robić wszystko oprócz pracy z produktami. Takie klucze są wycofywane: karta klucza podaje, kiedy Twój przestanie działać, i dostajesz też powiadomienie. Naciśnij Wygeneruj nowy klucz, który karta pokazuje wtedy jako główny przycisk, i wymień stary klucz na swojej stronie lub serwerze przed tą datą. Okno zaczyna się od samego Osadzone mapy, więc wybierz więcej, jeśli Twój serwer tego potrzebuje.

Wymień klucz#

Gdy masz już klucz, naciśnij ponownie Wygeneruj nowy klucz i utwórz nowy w oknie. Okno mówi, co stanie się z obecnym kluczem: Zostanie utworzony nowy klucz, a Twój obecny klucz będzie działał jeszcze przez 24 godziny, abyś mógł zaktualizować strony, które go używają. Możesz unieważnić go wcześniej, gdy skończysz. Klucz utworzony przed ustawieniami dostępu działa nadal do podanej Ci daty.

Stary klucz trafia do sekcji Poprzednie klucze, wraz z czasem, który mu został, datą ostatniego użycia i tym, co może robić. Nadal akceptowane, gdy wdrażasz nowy klucz. Unieważnij klucz, gdy tylko nic go już nie używa. Aby zatrzymać go od razu, naciśnij Unieważnij i potwierdź; każda strona, która jeszcze go używa, natychmiast przestaje działać. Przy unieważnieniu klucza dostajesz e-mail.

Ograniczenia dotyczące stron są kopiowane do nowego klucza. Nowy klucz możesz utworzyć mniej więcej raz na minutę.

Poprzedni klucz, nadal akceptowany przez kilka godzin, z przyciskiem Unieważnij

Ogranicz klucz do swoich stron#

Tylko strony z tej listy mogą używać Twojego klucza w przeglądarce: osadzone mapy i żądania ze stron w innych witrynach są odrzucane. Wywołania z serwera nie są objęte tym ograniczeniem.

W sekcji Ograniczenia stron internetowych wpisz swoją stronę w polu Wpisz stronę internetową lub domenę: domenę, np. example.com, adres IP lub localhost. Możesz wkleić pełny adres: zachowana zostanie tylko nazwa strony, bez https://, ścieżki i portu.
Naciśnij Dodaj.

Domena obejmuje także swoje subdomeny: example.com pozwala na shop.example.com. Naciśnij , aby usunąć stronę, i potwierdź; po usunięciu ostatniej klucz działa z dowolnej strony. Za każdym razem, gdy strona zostaje usunięta z klucza, dostajesz e-mail.

Lista dotyczy przeglądarek. Osadzona mapa otwiera się tylko na stronie z listy; gdy przeglądarka nie podaje, na jakiej stronie jest, zostaje odrzucona. Żądanie REST API wysłane ze strony internetowej musi pochodzić z jednej ze stron z listy. Żądanie z Twojego własnego serwera nie podaje żadnej strony i nie jest sprawdzane. Sam Measure Map Online jest zawsze dozwolony, więc podglądy na tej stronie nadal działają.

Ograniczenia dotyczące stron z dwiema dozwolonymi domenami

Zobacz, jak klucz jest używany#

Użycie sumuje wszystkie Twoje klucze live, więc liczby są ciągłe po wymianie klucza. Pokazuje żądania z ostatnich 30 dni, zarówno z osadzonych map, jak i z REST API, z słupkiem dla każdego dnia; sumę Cały czas; Ostatni dostęp; datę utworzenia bieżącego klucza (Klucz utworzony); oraz Najczęstsze domeny: strony, które najczęściej używają Twoich kluczy. Nieznana Ci strona na tej liście to powód, by ograniczyć lub wymienić klucz.

Żądania sandbox nie są liczone, więc liczby widać tylko w Produkcyjne. Nie są też liczone żądania, które sama ta strona wysyła w Wypróbuj API i podglądach.

Dbaj o bezpieczeństwo klucza#

Dawaj każdemu kluczowi tylko taki dostęp, jakiego potrzebuje. Klucz na stronie internetowej (na przykład w adresie osadzenia) powinien mieć tylko Osadzone mapy.
Ten klucz może zmieniać Twoje dane. Trzymaj go na swoim serwerze, nigdy na stronie internetowej ani w aplikacji.
Ogranicz klucz używany na stronach internetowych do własnych stron.
Zostaw klucz ukryty na stronie, gdy udostępniasz ekran; kopiowanie nigdy nie wymaga jego pokazania.
Jeśli klucz mógł wyciec, utwórz nowy i od razu unieważnij stary w sekcji Poprzednie klucze.
Buduj i testuj kluczem Piaskownica, aby eksperymenty nigdy nie trafiały między Twoje prawdziwe projekty.