Перейти к содержанию

Приложения

Раздел предназначен для управления приложениями — вашими API, которые нужно защитить.
После создания приложения вы получите команду для запуска Docker-контейнера (ноды), через которую будет проксироваться трафик API. Для отказоустойчивости можно запустить несколько нод.
Если на одной ноде нужно обрабатывать трафик разных API (с уникальными спецификациями), используйте группу приложений.

Создание приложения API Firewall Manager

Обратите внимание

Перед созданием приложений укажите корректный MANAGER_ADDRESS.
Этот адрес нужен ноде для подключения к Manager. Нода использует его для:
• получения OpenAPI-спецификаций,
• отправки событий и метрик.
Формат IP:PORT или DOMAIN_NAME:PORT, без указания схемы (http/https/etc)
IP \ DOMAIN_NAME – адрес или доменное имя, которое будет доступно из подсетей, где планируется запуск нод.
PORT – номер grpc порта, по умолчанию 8081.
Это значение автоматически добавится в команду запуска Docker-контейнера.

Создание группы приложений

Создание группы приложений

Для создания группы приложений выполните следующие шаги:

  1. Войдите в Консоль управления ПроAPI Защита через браузер.

  2. Перейдите в раздел Настройки, проверьте значение настройки MANAGER_ADDRESS – этот адрес будет подставляться в подсказку по запуску docker контейнера с фильтрующей нодой,
    Убедитесь, что указанное значение соответствует адресу, по которому доступна Консоль управления.

  3. Перейдите в раздел Приложения.

  4. Нажмите на кнопку Создать группу.

  5. В появившемся окне укажите:

    • Название приложения.
    • Описание (необязательно).
    • MANAGER_ADDRESS – HOST:PORT для подключения нод к Manager.
    • APIFW_Server_URL - URL защищаемого API, на него будут проксироваться запросы после фильтрации
    • Режим работы для сторонних запросов, которые не соответствуют ни одному из приложений:
      • Мониторинг: В этом режиме ПроAPI Защита отслеживает запросы, но не блокирует их.
      • Блокировка: В данном режиме ПроAPI Защита активно защищает ваше приложение, блокируя нежелательные запросы.
    • Уровень логирования для сторонних событий фильтрующей ноды.
      • ERROR: включает критические ошибки и ошибки валидации запросов.
      • WARNING: включает ошибки декодирования, проблемы валидации content-type.
      • INFO: включает ошибки типа «неизвестный эндпоинт».
      • DEBUG: более детальное логирование.
      • TRACE: помимо вышеперечисленного выводить http запросы и ответы, включая их содержимое.

  6. Нажмите кнопку Создать группу, чтобы сохранить данные и создать группу приложений.

  7. После успешного создания группы откроется окно, содержащее пример команды запуска docker контейнера с нодой ПроAPI Защита и токен группы приложений. Эти данные необходимы для интеграции ПроAPI Защиты в вашу систему:

    • Команда запуска: используйте эту команду для инициализации ПО ПроAPI Защита на сервере или устройстве.
    • Токен группы приложений: токен необходим для аутентификации и привязки ПО ПроAPI Защита к созданной вами группе приложений.

Создание приложения

Для создания приложения выполните следующие шаги:

  1. Войдите в Консоль управления ПроAPI Защита через браузер.

  2. Перейдите в раздел Настройки, проверьте значение настройки MANAGER_ADDRESS – этот адрес будет подставляться в подсказку по запуску docker контейнера с фильтрующей нодой, Убедитесь, что указанное значение соответствует адресу, по которому доступна консоль управления.

  3. Перейдите в раздел Приложения.

  4. Нажмите на кнопку Создать приложение.

  5. В появившемся окне укажите:

    • Название приложения.
    • Описание (необязательно).
    • Группу приложений (необязательно).
    • Источник спецификации: укажите файл спецификации, который будет использоваться для определения правил и ограничений для данного приложения.
    • MANAGER_ADDRESS – HOST:PORT для подключения нод к Manager.

    • APIFW_Server_URL - URL защищаемого API, на него будут проксироваться запросы после фильтрации

    • Режим работы для запросов:

      • Мониторинг: В этом режиме ПроAPI Защита отслеживает запросы, но не блокирует их.
      • Блокировка: В данном режиме ПроAPI Защита активно защищает ваше приложение, блокируя не соответствующие спецификации запросы.
    • Режим работы для валидации ответов:
      • Выключено: Ответы не проходят проверку.
      • Мониторинг: Ответы отслеживаются, но ошибки не приводят к блокировке.
      • Блокировка: Ответы проверяются, и в случае несоответствия спецификации, запрос блокируется.
    • Уровень логирования событий фильтрующей ноды.
      • ERROR: включает критические ошибки и ошибки валидации запросов.
      • WARNING: включает ошибки декодирования, проблемы валидации content-type, shadow api.
      • INFO: включает ошибки типа «неизвестный эндпоинт».
      • DEBUG: более детальное логирование.
      • TRACE: помимо вышеперечисленного выводить http запросы и ответы, включая их содержимое.

  6. Нажмите кнопку Создать приложение, чтобы сохранить данные и создать приложение.

  7. После успешного создания приложения откроется окно, содержащее пример команды запуска docker контейнера с нодой ПроAPI Защита и токен приложения. Эти данные необходимы для интеграции ПроAPI Защиты в вашу систему:

    • Команда запуска: используйте эту команду для инициализации ПО ПроAPI Защита на сервере или устройстве.
    • Токен приложения: токен необходим для аутентификации и привязки ПО ПроAPI Защита к созданному вами приложению.

Данные нужно сохранить и использовать при настройке интеграции с ПО ПроAPI Защита.