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

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

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

Архитектура

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

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

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

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

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

    • Если прокси использует серверы обновлений https://datagateway.api.2gis.com, то данные о пробках предоставляются для использования сервисами навигации.
    • Если прокси использует серверы обновлений https://jam.api.2gis.com, то данные о пробках предоставляются в векторном и растровом форматах для использования сервисами карт.
  2. Раздаёт эти данные по HTTP.

    Особенности настройки прокси для API пробок

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

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

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

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

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

Зависимости

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

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

Использование сервиса

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

Что дальше?