Ключі API · Довідка Measure Map Online

Створіть ключ, який з’єднує ваш вебсайт або програму з Measure Map Online, виберіть, що він може робити, розділіть робочу та тестову роботу, а також безпечно замінюйте його й обмежуйте.

Ключ API дає змогу вашому вебсайту або програмі працювати з вашим обліковим записом Measure Map Online: показувати карту проєкту на вашому сайті, створювати проєкти для відвідувачів або читати й змінювати проєкти через REST API. Ключі ви створюєте й керуєте ними на сторінці Розробник.

Відкрийте сторінку розробника#

У меню панелі в розділі Додатково натисніть Розробник. Вона відкривається на Ключі API, а інші її розділи перелічено під нею в меню (на телефоні вони з’являються як вкладки вгорі сторінки):

Гостьове посилання (Open Guest): посилання для вашого вебсайту без коду. Див. Open Guest.
Спробувати API, Вебхуки і REST API: див. довідник API.
Вбудувати карту (Enterprise): див. iFrame API.
Приватні проєкти (Enterprise): показуйте приватні проєкти клієнтів у своїх вбудованих картах. Див. приватні проєкти клієнтів.

Позначка вгорі картки ключа показує, що ваш ключ Активний, Не активовано (ключа ще немає), Вимкнено (доступ до API призупинено: жоден ключ не працює і новий створити не можна, доки підтримка не зніме обмеження) або Закінчився (підписка не активна).

Розділ ключів API із ключем Sandbox, прихованим, окрім початку й кінця, його можливостями, кнопками показу й копіювання та кнопкою створення нового ключа

Live і Sandbox#

Угорі картки ключа перемикайтеся між Робоче і Пісочниця. У кожного середовища свій ключ, і сторінка показує той, який ви вибрали. Цей вибір діє й у Спробувати API, і зберігається під час переходу між розділами. Вбудувати карту і Гостьове посилання завжди використовують ваш робочий ключ, бо відвідувачі вашого вебсайту можуть відкривати лише робочі проєкти: відкриття будь-якого з них повертає сторінку на Робоче.

Робоче — це ваш справжній обліковий запис, і сторінка відкривається саме на ньому. Використовуйте робочий ключ на своєму вебсайті.
Пісочниця призначено для створення й тестування інтеграції. Проєкти, папки та продукти, створені ключем sandbox, зберігаються окремо від справжніх: робочий ключ їх не бачить, а ключ sandbox не бачить ваших робочих. Запити, зроблені ключем sandbox, не враховуються в даних про використання, а гостьові проєкти, створені з ним, ніколи не тарифікуються.

Створення нового ключа sandbox ніколи не впливає на ваш робочий ключ, і навпаки.

Виберіть, що може робити ключ#

Коли ви створюєте ключ, діалог перелічує кожну ділянку API в розділі Доступ для нового ключа. Виберіть, наскільки далеко новий ключ сягає в кожну з них:

Ділянка	Варіанти	Що це дозволяє
Вбудовані карти (Enterprise)	Немає доступу, Дозволено	Вхід глядача до вбудованої карти. Для більшості інтеграцій потрібне лише це.
Гостьові проєкти (Open Guest)	Немає доступу, Дозволено	Створення гостьового проєкту для відвідувача за допомогою токена з вашого сервера. Для більшості інтеграцій потрібне лише це.
Проєкти	Немає доступу, Читання, Читання та зміна	Проєкти й папки з їхніми вимірюваннями, коментарями та експортами.
Користувачі (Enterprise)	Немає доступу, Читання, Читання та зміна	Користувачі вашої організації, їхні запрошення, місця й команди.
Організація (Enterprise)	Немає доступу, Читання, Читання та зміна	Профіль, політика, єдиний вхід і журнал активності вашої організації, а також її місця.
Продукти	Немає доступу, Читання, Читання та зміна	Ваш каталог продуктів та його ціни.
Гості (Open Guest)	Немає доступу, Читання, Читання та зміна	Ваше гостьове посилання, гостьові проєкти й запити на кошторис, контактні дані ваших гостей і ваш бюджет.
Обліковий запис	Немає доступу, Читання, Читання та зміна	Ваш план, місця, використання API, профіль і налаштування листів, а в Open Guest — витрати й бюджет.
Розробник	Немає доступу, Читання, Читання та зміна	Ваші API-ключі та вебхук. Ключ ніколи не виходить за межі власного доступу.
Клієнти (партнер)	Немає доступу, Читання, Читання та зміна	Ваші клієнти, плани, які ви за них оплачуєте, їхні запрошення й рахунки.

Діалог показує лише ті ділянки, які входять до вашого плану. Наведіть вказівник на варіант, щоб побачити, що саме він дозволяє. Ваш перший ключ починається лише з Вбудовані карти, чого достатньо для вбудованої карти; ключ, що замінює інший, починається з доступу того ключа. Виберіть щонайменше одну ділянку.

Що може робити ключ, визначається під час його створення. Щоб дати ключу більше або менше доступу, створіть новий.

Створіть ключ#

Угорі картки ключа виберіть Робоче або Пісочниця.
Натисніть Створити новий ключ. Відкриється діалог, а поруч із його заголовком буде Робоче або Пісочниця.
Задайте доступ у розділі Доступ для нового ключа (див. вище).
За бажання введіть назву в полі Назва нового ключа (необов’язково), щоб розрізняти свої ключі.
Натисніть Створити.

Діалог створення нового ключа: середовище Live, доступ до кожної ділянки API та назва ключа

Тоді діалог повідомить Ваш новий ключ готовий. Ви можете знову скопіювати його з цієї сторінки в будь-який час. Він показує ключ, прихований, окрім його перших і останніх символів, і те, що він Може. Натисніть , щоб показати його повністю, або , щоб скопіювати весь ключ, а потім натисніть Готово. Картка ключа показує його так само в розділі Ваш ключ API. Щоразу, коли у вашому обліковому записі створюється ключ, ви отримуєте лист.

Ключі, створені до появи налаштувань доступу#

Ключ, створений до появи в ключів налаштувань доступу, може робити все, окрім роботи з продуктами. Такі ключі виводяться з використання: картка ключа каже, коли ваш перестане працювати, і ви також отримаєте сповіщення. Натисніть Створити новий ключ, яка тоді стає на картці головною кнопкою, і замініть старий ключ на своєму вебсайті або сервері до цієї дати. Діалог починається лише з Вбудовані карти, тож виберіть більше, якщо вашому серверу це потрібно.

Замініть ключ#

Знову натисніть Створити новий ключ, коли у вас уже є ключ, і створіть новий у діалозі. Діалог пояснює, що станеться з поточним ключем: Буде створено новий ключ, а поточний працюватиме ще 24 години, щоб ви могли оновити сайти, які його використовують. Ви можете відкликати його раніше, коли закінчите. Ключ, створений до появи налаштувань доступу, працює до вказаної вам дати.

Старий ключ переходить до розділу Попередні ключі із часом, що йому залишився, останнім використанням і можливостями. Усе ще приймаються, поки ви впроваджуєте новий ключ. Відкличте ключ, щойно ним ніхто не користується. Щоб зупинити його одразу, натисніть Відкликати і підтвердьте; кожен сайт, що ще його використовує, негайно перестане працювати. Коли ключ відкликають, ви отримуєте лист.

Обмеження для ваших вебсайтів копіюються до нового ключа. Новий ключ можна створювати приблизно раз на хвилину.

Попередній ключ, який ще приймається кілька годин, із кнопкою Відкликати

Обмежте ключ вашими вебсайтами#

Лише вебсайти з цього списку можуть використовувати ваш ключ у браузері: вбудовані карти та запити зі сторінок будь-яких інших сайтів відхиляються. Виклики із сервера це не стосується.

У розділі Обмеження за вебсайтами введіть свій сайт у полі Введіть вебсайт або домен: домен, як-от example.com, IP-адресу або localhost. Можна вставити повну адресу: збережеться лише назва сайту, без https://, шляху та порту.
Натисніть Додати.

Домен охоплює і свої піддомени: example.com дозволяє shop.example.com. Натисніть , щоб вилучити сайт, і підтвердьте; після останнього ключ працює з будь-якого вебсайту. Щоразу, коли вебсайт вилучають із ключа, ви отримуєте лист.

Список стосується браузерів. Вбудована карта відкривається лише на сторінці вебсайту зі списку; якщо браузер не повідомляє, на якій сторінці він перебуває, у відкритті буде відмовлено. Запит REST API, надісланий з вебсторінки, має надходити зі вебсайту зі списку. Запит із вашого власного сервера не називає жодного вебсайту і не перевіряється. Сам Measure Map Online завжди дозволений, тому попередні перегляди на цій сторінці продовжують працювати.

Обмеження вебсайтів із двома дозволеними доменами

Дивіться, як використовується ключ#

Використання підсумовує всі ваші робочі ключі, тож показники тривають і після заміни ключа. Тут видно запити за останні 30 днів, як від вбудованих карт, так і від REST API, зі стовпчиком для кожного дня; загальну кількість За весь час; Останній доступ; коли створено поточний ключ (Ключ створено); та Найпопулярніші домени: вебсайти, які найчастіше використовують ваші ключі. Вебсайт, якого ви не впізнаєте, — привід обмежити або замінити ключ.

Запити sandbox не враховуються, тому показники видно лише на Робоче. Не враховуються й запити, які сама ця сторінка робить у Спробувати API та попередніх переглядах.

Бережіть свій ключ#

Давайте кожному ключу лише потрібний йому доступ. Ключ на вебсторінці (наприклад, в адресі вбудованої карти) має мати лише Вбудовані карти.
Цей ключ може змінювати ваші дані. Зберігайте його на своєму сервері, ніколи не на вебсторінці чи в застосунку.
Обмежуйте ключ, що використовується на вебсторінках, вашими власними вебсайтами.
Тримайте ключ прихованим на сторінці, коли показуєте свій екран; для копіювання його показувати не потрібно.
Якщо ключ міг витекти, створіть новий і негайно відкличте старий у розділі Попередні ключі.
Створюйте й тестуйте з ключем Пісочниця, щоб експерименти ніколи не потрапляли до ваших справжніх проєктів.