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

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

Инструкция описывает процесс создания приложений, защищаемых с помощью ПО ПроAPI Защита.

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

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

  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 Защита.