Добавление и изменение API-ключа в Mapfolio

После создания API-ключа в Кабинете разработчика Яндекса его необходимо добавить в Mapfolio.

Сохранённый ключ будет использоваться при загрузке Яндекс Карты в вашем виджете.

Что понадобится

Перед началом подготовьте:

  • открытый личный кабинет Mapfolio;
  • API-ключ, скопированный из Кабинета разработчика Яндекса;
  • адрес сайта, добавленный в ограничения ключа.

API-ключ выглядит как длинная строка из латинских букв, цифр и дефисов.

Как открыть настройку API-ключа

  1. Войдите в личный кабинет Mapfolio.
  2. В верхнем меню откройте раздел «Настройки».
  3. Выберите вкладку «API ключи».
  4. Найдите блок «API ключ Яндекс.Карты».

Внутри блока находятся:

  • поле «Введите API»;
  • кнопка «Сохранить»;
  • ссылка «Инструкция подключения».
Раздел для подключения API-ключа в Mapfolio

Как добавить API-ключ

  1. Нажмите на поле «Введите API».
  2. Вставьте скопированный ключ.

На компьютере для вставки можно нажать Ctrl + V.

  1. Проверьте, что ключ вставлен полностью.
  2. Убедитесь, что перед первым символом и после последнего символа нет лишнего текста.
  3. Нажмите кнопку «Сохранить».

Во время сохранения на кнопке появится надпись «Сохраняем».

Как понять, что ключ сохранён

После успешного сохранения:

  • поле с ключом будет заблокировано от случайного изменения;
  • вместо кнопки «Сохранить» появится кнопка «Изменить»;
  • сообщение о демонстрационном режиме исчезнет;
  • ключ станет доступен при настройке виджета.

Если кнопка «Изменить» появилась, Mapfolio сохранил введённый ключ.

API-ключ успешно сохранён

Mapfolio проверяет формат введённого ключа, но не может сразу подтвердить все его настройки на стороне Яндекса.

Успешное сохранение ещё не означает, что:

  • ключ создан для нужного API;
  • ключ активен;
  • домен сайта добавлен в ограничения;
  • на стороне Яндекса уже применились изменения.

Окончательно проверить работу ключа можно после загрузки карты в виджете.

Как ключ связывается с виджетом

При добавлении первого API-ключа Mapfolio автоматически связывает его с вашими виджетами, для которых ключ ещё не был выбран.

При создании или редактировании виджета ключ также можно проверить вручную:

  1. Откройте раздел «Виджеты».
  2. Создайте новый виджет или откройте существующий.
  3. Перейдите к разделу «2. API карты».
  4. Откройте список подключённых API.
  5. Выберите «Яндекс карты #1».
Выбор сохранённого API-ключа для виджета

Как проверить работу добавленного ключа

После сохранения ключа проверьте карту:

  1. Откройте виджет, связанный с ключом.
  2. Посмотрите, загрузилась ли карта в предварительном просмотре.
  3. Если виджет уже установлен, откройте страницу своего сайта.
  4. Обновите страницу.
  5. Убедитесь, что вместо ошибки отображается карта с точками.
  6. Попробуйте переместить и увеличить карту.

Если ключ или его ограничения были созданы недавно, подождите до 15 минут и повторите проверку.

Как изменить сохранённый API-ключ

API-ключ можно заменить, если:

  • вы создали новый ключ;
  • старый ключ был заблокирован;
  • ключ был удалён в Кабинете разработчика;
  • для сайта необходимо использовать другой ключ;
  • карта перестала работать из-за настроек старого ключа.

Замена ключа

  1. Откройте «Настройки».
  2. Перейдите во вкладку «API ключи».
  3. Найдите блок «API ключ Яндекс.Карты».
  4. Нажмите кнопку «Изменить».
  5. Поле станет доступным для редактирования.
  6. Сохранённый ключ будет выделен.
  7. Вставьте новый ключ сочетанием клавиш Ctrl + V.

При вставке выделенный старый ключ будет заменён новым.

  1. Проверьте введённое значение.
  2. Нажмите кнопку «Сохранить».
  3. Дождитесь, пока снова появится кнопка «Изменить».

Что произойдёт с существующими виджетами

Если виджеты уже используют изменяемый ключ, после сохранения они начнут получать его новое значение.

Заново создавать точки, карточки и сам виджет не потребуется. Также не нужно повторно вставлять код виджета на сайт.

Достаточно обновить страницу сайта и проверить загрузку карты.

Как отключить API-ключ

Если ключ больше не должен использоваться:

  1. Откройте вкладку «API ключи».
  2. Нажмите кнопку «Изменить».
  3. Удалите из поля всё значение ключа.
  4. Убедитесь, что поле осталось пустым.
  5. Нажмите кнопку «Сохранить».

После этого ключ будет удалён из настроек Mapfolio, а карта вернётся в демонстрационный режим.

Возможные ошибки

Сообщение или ситуация Возможная причина Что сделать
«Введите корректный API ключ Яндекс.Карт» Ключ вставлен не полностью или имеет неправильный формат Скопируйте ключ в кабинете Яндекса заново
Кнопка «Сохранить» недоступна В поле введено некорректное значение Проверьте все символы и дефисы
«Не удалось сохранить API ключ» Проблема с интернет-соединением Проверьте интернет и повторите сохранение
Кнопка «Изменить» появилась, но карта не работает Ошибка в настройках ключа на стороне Яндекса Проверьте JavaScript API и HTTP Referer
Карта работает в кабинете, но не на сайте Домен сайта не разрешён для ключа Добавьте домен в ограничения ключа
Ключ только что создан Яндекс ещё не активировал изменения Подождите до 15 минут
После замены карта исчезла Новый ключ неактивен или настроен неверно Верните старый ключ либо исправьте настройки нового

Короткая проверка

API-ключ добавлен правильно, если:

  • во вкладке «API ключи» отображается сохранённое значение;
  • рядом с полем находится кнопка «Изменить»;
  • ключ доступен в разделе виджета «2. API карты»;
  • сообщение о демонстрационном режиме не отображается;
  • карта загружается на странице сайта;
  • на карте видны ваши точки.