Перейти к основному содержимому

Работа с Менеджером Платформы

Отличия версий On-Cloud и On-Premise​

Менеджер Платформы доступен как On-Cloud, так и On-Premise. Доступные функции различаются в зависимости от инсталляции.

On-CloudOn-Premise
Просмотр лицензий✗✓
Создание ключей доступа✓✓
Управление ключами доступа✓✓
Управление пользователями✓
(См. инструкцию Управление пользователями)
✓
(Только изменение ролей пользователей: см. раздел Управление ролями пользователей)
Управление компаниями✓
(См. инструкцию Управление компаниями)
✗
Загрузка пользовательских
стилей карты
✗
(Можно указать стиль в настройках карты)
✓
Тестирование сервисов
в песочнице
✓✓
Просмотр статистики
по ключам доступа
✓✓
Мониторинг состояния сервисов✗✓

Начало работы​

  1. Убедитесь, что сервис Менеджер Платформы установлен и работает корректно. Подробнее см. в инструкции по установке Менеджера Платформы.
  2. Перейдите по ссылке вида https://platform.example.com, которую вы получили в результате установки сервиса.

Интерфейс Менеджера Платформы​

Работайте со следующими вкладками в Менеджере Платформы:

  • Лицензии: для просмотра информации о лицензиях, установленных внутри комплекса On-Premise.
  • Ключи API: для просмотра списка API-ключей и управления сервисами, которые в них входят.
  • Стили карты: для загрузки и управления пользовательскими стилями карты.
  • Песочницы: для тестирования работы ключевых API.
  • Статистика: для просмотра статистики по ключам доступа и скачивания в виде файла.
  • Мониторинг: для просмотра статусов сервисов, установленных внутри программного комплекса On-Premise.

Просмотр лицензий​

На вкладке Лицензии вы можете посмотреть информацию о лицензиях, установленных внутри комплекса On-Premise.

Для каждой лицензии отображается:

  • сервис, для которого выпущена лицензия;
  • ID лицензии;
  • срок действия;
  • статус: Активная, Скоро истечёт (появляется за 10 дней до истечения) и Истекла.
Вкладка Лицензии

Чтобы посмотреть JSON-файл с дополнительными параметрами лицензии, нажмите значок Меню лицензии рядом с лицензией.

Управление API-ключами​

Управлять API-ключами доступа могут пользователи с ролью Администратор.

Создание ключа​

Чтобы создать новый API-ключ:

  1. Перейдите на вкладку Ключи API.
  2. Нажмите Создать API-ключ.
  3. Введите название ключа и нажмите Создать.

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

Настройка сервисов в ключе​

Чтобы настроить сервисы в API-ключе:

  1. В разделе Ключи API нажмите на название ключа, чтобы открыть список входящих в него сервисов.
  2. Включите или отключите сервис в списке.

Настройка лимитов сервиса в ключе​

Чтобы настроить лимиты сервиса в API-ключе:

  1. В разделе Ключи API нажмите на название ключа, чтобы открыть список входящих в него сервисов.

  2. На вкладке Сервисы в строке с сервисом нажмите значок Редактировать.

  3. Укажите значения лимитов для сервиса:

    • Период лимитов — временной период, за который учитывается расходование лимитов: минута, день или месяц.

    • Лимит достигнут — событие, которое наступит после исчерпания лимита: уведомление, остановка или блокировка.

      примечание

      Уведомление по email (опция Уведомление) недоступно On-Premise.

    • Лимит — значение лимита для сервиса в выбранном периоде. При достижении этого лимита за указанный период наступит событие, выбранное в параметре Лимит достигнут.

  4. (Опционально) Нажмите Добавить лимит, чтобы задать дополнительные лимиты для сервиса.

  5. Нажмите Сохранить.

Настройка ограничений в ключе​

  1. Перейдите на вкладку Ключи API и выберите ключ.

  2. В разделе Ограничения настройте ограничения ключа:

    Ограничения ключа
  3. Нажмите Сохранить изменения.

По HTTP-заголовкам​

Ограничивает доступ по HTTP-заголовкам в запросе:

  • Referer: по URL страницы.
  • Origin: по имени сервера.
  • User-Agent: по типу приложения, операционной системе и другим параметрам.

Например, чтобы разрешить доступ только для запросов с домена example.com и от браузера с настройкой User-Agent Mozilla/5.0:

  1. В поле Origin укажите example.com.
  2. В поле User-Agent укажите Mozilla/5.0.
  3. Нажмите Сохранить изменения.

Ключ будет работать только для запросов с заголовком Origin: example.com и User-Agent: Mozilla/5.0. Запросы с других доменов (например, test.com) или от других клиентов (например, curl/7.0) будут отклонены.

По IP и подсетям​

Ограничивает доступ по списку IP-адресов или подсетей в формате CIDR (например, 192.168.1.0/24). Ограничение использует IP-адрес клиента, который передаётся в следующих заголовках:

  • Remote-Addr: IP-адрес источника TCP-соединения или IP-адрес прокси-сервера при использовании прокси или NAT.
  • X-Forwarded-For: цепочка IP-адресов, где первый адрес — IP клиента. Рекомендуется использовать этот заголовок, так как он поддерживает сложные сетевые конфигурации с прокси.
  • X-Real-IP: IP-адрес клиента, переданный прокси.

Например, чтобы разрешить доступ для запросов только с IP-адресов корпоративной подсети 192.168.1.0/24:

  1. В поле CIDR укажите подсеть 192.168.1.0/24.

  2. Нажмите Сохранить изменения.

  3. Если вы используете прокси или NAT, заголовки могут отсутствовать или содержать неверный IP-адрес клиента, что может нарушить работу ограничения. Убедитесь, что ваша инфраструктура (прокси, балансировщики нагрузки, NAT, Ingress) передаёт заголовки с оригинальным IP-адресом клиента:

    • Проверьте конфигурацию Ingress-контроллера nginx в вашем кластере Kubernetes (например, файл values.yaml в Helm-чарте).
    • Проверьте конфигурацию прокси или балансировщика нагрузки (например, директиву proxy_set_header в nginx).
    • Включите логирование HTTP-заголовков (Remote-Addr, X-Forwarded-For, X-Real-IP) в сервисе API-ключей.
    • Используйте инструменты анализа трафика для подтверждения, что хотя бы один заголовок содержит правильный IP-адрес клиента (например, Wireshark, tcpdump).

Ключ будет работать только для запросов с IP-адресов из диапазона 192.168.1.0 — 192.168.1.255 при условии, что с IP-адреса клиента корректно передаётся один из заголовков (Remote-Addr, X-Forwarded-For, X-Real-IP). Запросы с других IP-адресов (например, 10.0.0.1) или без корректных заголовков будут отклонены.

По приложению​

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

Например, чтобы разрешить доступ для запросов только от приложения с идентификатором ru.dgis.sdk.app:

  1. В поле App ID укажите ru.dgis.sdk.app.
  2. Нажмите Сохранить изменения.

Ключ будет работать только для запросов от приложения с идентификатором ru.dgis.sdk.app. Запросы от других приложений (например, ru.dgis.test.app) будут отклонены.

Настройка JSON-параметров сервиса в ключе​

Для сервисов, включённых в API-ключ, можно настроить дополнительные JSON-параметры. Ниже описаны частые сценарии использования этой настройки.

Настройка размера матрицы для Distance Matrix API​

Чтобы изменить максимальное количество точек отправления и назначения, которые партнёр может передать в одном запросе к Distance Matrix API:

  1. В разделе Ключи API нажмите на название ключа, чтобы открыть список входящих в него сервисов.

  2. В строке с сервисом Distance Matrix API нажмите значок Редактировать.

    Откроется текстовое поле с текущими JSON-параметрами сервиса для этого ключа. Если параметры ранее не задавались, поле будет пустым.

  3. Перейдите на вкладку Partner и в текстовом поле укажите значения в полях max_sources и max_targets, например:

    {
    "max_sources": 10,
    "max_targets": 10
    }

    Где:

    • max_sources — максимальное количество точек отправления в одном запросе.
    • max_targets — максимальное количество точек назначения в одном запросе.
  4. Нажмите Сохранить.

Ограничения

Отдельно задать размер матрицы для синхронных и асинхронных запросов не получится — ограничение общее для обоих типов запросов в рамках одного ключа. Чтобы задать разные лимиты для синхронных и асинхронных запросов, используйте два разных API-ключа с разными значениями max_sources и max_targets.

Настройка доступных полей для Places API​

Вы можете разрешить партнёру получать через Places API дополнительные поля с информацией об объекте (например, данные об этажах здания) или предоставить доступ к отдельным правам, например к показу email для всех филиалов. Для этого:

  1. В разделе Ключи API нажмите на название ключа, чтобы открыть список входящих в него сервисов.

  2. В строке с сервисом Places API нажмите значок Редактировать.

    Откроется текстовое поле с текущими JSON-параметрами сервиса для этого ключа. Если параметры ранее не задавались, поле будет пустым.

  3. Перейдите на вкладку Partner и в текстовом поле укажите поля в массиве fields и права в массиве permissions, например:

    {
    "fields": [
    "items.floors",
    "items.floor_plans"
    ],
    "permissions": [
    "allow_emails_for_all_branches"
    ]
    }
    Доступные значения
    • Значения полей внутри fields:

      • Поля с информацией о геометрии и адресе места:

        • items.point — координаты объекта, заданные в системе координат WGS84(4326) в формате lon, lat.
        • items.address — адрес объекта без указания города.
        • items.adm_div — принадлежность к административной территории.
        • items.full_address_name — адрес объекта с указанием города.
        • items.geometry.centroid — визуальный центр геометрии объекта.
        • items.geometry.hover — геометрия области, используемой для определения попадания курсора в зону объекта.
        • items.geometry.selection — геометрия для выделения объекта.
      • Поля с дополнительной информацией о месте:

        • items.rubrics — категории компании.
        • items.org — организация, к которой относится филиал.
        • items.brand — бренд, к которому относится филиал.
        • items.schedule — расписание работы компании.
        • items.schedule_special — особое расписание работы компании.
        • items.access — тип доступа для парковки.
        • items.capacity — вместимость парковки.
        • items.description — описание геообъекта.
        • items.flags — список признаков объекта. Например, что для объекта есть фотографии, или что филиал временно не работает и т. д. Список доступных признаков можно посмотреть в схеме ответа внутри items.
        • items.floors — количество этажей.
        • items.floor_plans — планы этажей.
        • items.is_paid — является ли парковка платной.
        • items.for_trucks — парковка для грузовиков.
        • items.is_incentive — перехватывающая ли парковка.
        • items.purpose — назначение парковки.
        • items.level_count — количество уровней парковки.
        • items.links — связанные объекты (ближайшие парковки, остановки общественного транспорта и другое).
        • items.links.database_entrances — информация о точках входа.
        • items.links.database_entrances.apartments_info — информация о квартирах в доме.
        • items.name_ex — составные части наименования объекта.
      • Служебные поля:

        • items.geometry.style — идентификатор стиля для отображения.
        • items.group — связанные в объединённую карточку объекты.
        • items.is_main_in_group — признак того, что это главный объект в группе объектов гибрида.
        • items.city_alias — алиас города, в котором находится объект.
        • items.detailed_subtype — детализированный тип административно-территориальной единицы.
        • items.alias — транслитерированное название объекта.
        • items.caption — название объекта.
        • items.routes — маршруты транспорта, проходящие через станцию или остановку.
        • items.directions — направления маршрута.
        • items.is_routing_available — признак, указывающий, возможен ли проезд до объекта.
        • items.entrance_display_name — номер входа на станцию метро, если объект — это вход (station_entrance).
        • items.locale — текущая локаль для региона.
        • items.region_id — уникальный идентификатор проекта.
        • items.segment_id — уникальный идентификатор сегмента.
        • items.has_apartments_info — признак наличия информации о квартирах в здании.
        • items.station_id — уникальный идентификатор остановки, к которой относится остановочная платформа.
        • items.platforms — остановочные платформы остановки.
        • items.search_attributes — параметры результата поиска для найденного объекта. Каждое поле внутри items.search_attributes нужно запрашивать отдельно через точку, например, items.search_attributes.segment_id. Список доступных полей внутри объекта items.search_attributes можно посмотреть в схеме ответа для любого объекта внутри items.
        • items.poi_category — категория POI.
        • items.temporary_unavailable_atm_services — признак наличия неработающих услуг у банкомата или терминала.
        • items.floor_id — идентификатор этажа.
        • items.purpose_code — код назначения здания.
        • items.name_back — локализованное название дорожного знака в обратном направлении (при наличии).
        • items.value_back — номер километра на дорожном знаке в обратном направлении.
        • items.ev_charging_station — атрибуты электрозаправок.
        • items.ski_lift — информация о горнолыжном подъемнике.
        • items.summary — блок обобщённой информации.
        • items.settlements_group_name — наименование поселения.
        • items.sport_route_type_name — тип спортивного маршрута.
        • items.ski_track — информация о горнолыжной трассе.
    • Значения полей внутри permissions:

      • allow_emails_for_all_branches — разрешение на просмотр email в списке контактов для всех филиалов.
      • government_address_classifiers — разрешение на просмотр кодов государственных классификаторов: ФИАС, ОКАТО, ОКТМО.
  4. Нажмите Сохранить.

Блокировка ключа​

предупреждение

Заблокированный ключ активировать снова не получится.

При блокировке ключа партнёр не сможет использовать его для доступа к сервисам. Статус ключа изменится на Неактивен.

  1. Перейдите на вкладку Ключи API.

  2. Заблокируйте ключ одним из способов:

    • В строке с ключом нажмите Меню лицензии → Заблокировать.
    • Нажмите на название ключа и в открывшемся окне нажмите Действия → Заблокировать.

Управление ролями пользователей​

Пользователи с ролью Администратор могут изменять роли других пользователей.

  1. Перейдите на вкладку Пользователи.
  2. В строке с пользователем, роль которого нужно изменить, нажмите Меню → Изменить роль.
  3. В открывшемся окне выберите новую роль для пользователя и нажмите Отправить.
примечание

Уведомление по email недоступно On-Premise.

Управление стилями карты​

На вкладке Стили карты вы можете:

Вкладка Стили карты

Загрузка и применение стиля карты​

Чтобы создать уникальный стиль карты и использовать его в своём контуре:

  1. Убедитесь, что установлен Styles API.

  2. Откройте Редактор стилей и создайте стиль карты.

    См. инструкции по созданию и настройке стилей в документации Редактора стилей.

  3. Выгрузите созданный стиль из Редактора стилей:

    1. В Редакторе стилей в блоке Мои стили откройте карточку стиля.

    2. В верхнем меню нажмите Поделиться. В открывшемся окне нажмите Экспорт стиля.

      Экспорт стиля
    3. Отметьте стиль в списке и нажмите Экспортировать.

      В новой панели начнётся подготовка архива для скачивания.

    4. Когда стиль будет в статусе Готово, выберите его в списке и нажмите Скачать стиль.

    5. Сохраните созданный архив в формате .tar.gz локально.

  4. Загрузите стиль в контур On-Premise:

    1. Откройте Менеджер Платформы.
    2. Перейдите на вкладку Стили карты и нажмите Загрузить стиль.
    3. Добавьте скачанный архив в формате .tar.gz и дождитесь его загрузки (архив должен перейти в статус Загружено).
  5. Чтобы проверить, как выглядит загруженный стиль в песочнице, на вкладке Стили карты нажмите на название стиля.

  6. Скопируйте сгенерированный ID стиля в поле ID стиля карты и примените его к карте с помощью MapGL JS API.

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

Обновление стиля карты​

Вы можете применить к картам новый стиль или обновить созданный ранее.

  1. Откройте Редактор стилей и создайте новый стиль или отредактируйте существующий.

    См. инструкции по созданию и настройке стилей в документации Редактора стилей.

  2. Выполните шаги по выгрузке стиля из Редактора стилей и загрузке в Менеджер Платформы.

  3. Если вы загружаете обновлённую версию существующего стиля, его ID остаётся прежним. Менеджер Платформы распознает обновление как новую версию стиля. В дальнейшем вы сможете переключаться между версиями одного стиля.

  4. Если вы загружаете новый стиль, скопируйте сгенерированный ID стиля в поле ID стиля карты и примените его к карте с помощью MapGL JS API.

Удаление стиля карты​

предупреждение

Перед удалением стиля убедитесь, что он не применён ни к одной из действующих карт. В противном случае после удаления стиля карта может отображаться некорректно.

  1. Перейдите на вкладку Стили карты.
  2. Нажмите Корзина рядом с нужным стилем.

Работа с песочницами​

На вкладке Песочницы вы можете протестировать работу ключевых API, не устанавливая их:

  • Map Tiles API: трёхмерную интерактивную карту на движке WebGL с использованием MapGL JS.
  • Static API: статические карты без использования JavaScript.
  • Geocoder API: API поиска для определения координат объекта по адресу (прямой геокодинг) и наоборот (обратный геокодинг).
  • Directions API: API навигации для построения автомобильных, велосипедных и пешеходных маршрутов.
Вкладка Песочницы

Пример работы с песочницей Map Tiles API:

Песочница Map Tiles API

Просмотр статистики​

На вкладке Статистика вы можете посмотреть подробные данные о количестве запросов. Вы можете отфильтровать данные по временному периоду, сервису и API-ключу.

Пример отображения статистики:

Вкладка Статистика

На графике отображается количество запросов к сервисам за год с разбивкой по месяцам.

Статистика распределения запросов​

Чтобы посмотреть статистику распределения запросов:

  1. Перейдите на вкладку Статистика.

  2. Выберите период, за который нужно получить статистику (сегодня, последняя неделя, месяц, год), или укажите произвольный период в поле Период. Дата и время указываются в формате UTC. При выборе месячного или годового периода в поле Разбивка можно выбрать, как будут отображаться данные: по дням, неделям или месяцам.

  3. В поле Ключ выберите ключи доступа, по которым нужно получить статистику. Чтобы выбрать все ключи, выберите Выбрать все.

    Чтобы отфильтровать ключи по статусу и режиму использования, нажмите значок Фильтр, выберите статус ключа (Активен, Неактивен) и режим (Demo для демо-ключа и Prod для основного ключа).

  4. В поле Сервис выберите сервисы, по которым нужно получить статистику. Чтобы выбрать все сервисы, выберите Выбрать все.

Скачивание файла со статистикой​

Вы можете скачать статистику в виде файла с таблицей в формате .xlsx. Таблица содержит поля:

  • Ключ: ID ключа.
  • Дата: дата запроса.
  • Сервис: сервис, к которому был отправлен запрос.
  • Режим: режим использования ключа (демо-ключ demo или основной ключ prod).
  • Метод: endpoint, к которому был отправлен запрос.
  • Результат: результат запроса (Успех, Пустой ответ, Ошибка).
  • Код результата: код результата запроса.
  • Количество запросов: количество запросов в течение дня, указанного в дате.
  • Организации: количество организаций, полученных через Places API, Suggest API и Markers API.
  • Геообъекты: количество геообъектов, полученных через API поиска.
  • Маршруты: количество маршрутов, построенных через API навигации, кроме Isochrone API.

Чтобы скачать файл со статистикой распределения запросов:

  1. Перейдите на вкладку Статистика.
  2. Выберите период, ключи и сервисы.
  3. Нажмите Скачать в формате XLSX.

Мониторинг состояния сервисов​

На вкладке Мониторинг вы можете просматривать список сервисов, установленных внутри комплекса On-Premise, и проверять статус их работы.

Вкладка Мониторинг