Прокси для API пробок | On‑Premise | 2GIS Documentation
On‑Premise
Личный кабинет

Прокси для API пробок

Сервис прокси позволяет получать данные о пробках в реальном времени для сервисов программного комплекса 2ГИС, которым нужны эти данные.

Архитектура прокси для API пробок

Этот сервис включает в себя только сервис NGINX (обратный прокси).

Обратный прокси NGINX:

  1. Получает данные о пробках в реальном времени с публичных серверов обновлений для пробок 2ГИС.

    Прокси для API пробок может быть установлен в разных конфигурациях, которые зависят от используемых серверов обновлений:

    • Если прокси использует серверы обновлений https://traffic-jams.2gis.com, то данные о пробках предоставляются в векторном формате, который подходит для использования сервисами навигации.
    • Если прокси использует серверы обновлений https://traffic0.edromaps.2gis.com/ или https://traffic0.maps.2gis.com/, то данные о пробках предоставляются в растровом формате.
  2. Раздает эти данные по HTTP.

    Важное примечание:

    Различные сервисы требуют установки определенной конфигурации прокси для API пробок, использующей конкретные серверы обновлений для пробок (настройка proxy.host). См. детали в документации соответствующих сервисов.

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

    • Прокси, который раздает данные о пробках в растровом формате, также может использоваться бэкендом SPCore.
    • Прокси, который раздает данные о пробках в формате для навигации, недоступен для конечных пользователей и приложений, и предоставляет данные исключительно сервису Navi-Back.

    Пример для сервиса карт в конфигурации с MapGL JS API и Tiles API:

    Пример организации доступа в интернет для сервиса карт

Обратному прокси NGINX должен быть предоставлен доступ в интернет, чтобы этот сервис мог обращаться к публичным серверам обновлений для пробок 2ГИС.

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

Настройте сервис на использование адреса, указанного в параметре ingress.hosts.host, в качестве Traffic API endpoint. См. детали в документации соответствующих сервисов.

Что дальше?