Настройка In-App адаптера

Обзор

In-App баннер адаптер Accelera Flows - это модуль для предоставления данных из динамических профилей системы Accelera. Обмен данными происходит по протоколу HTTP.

Формат сообщения - JSON, пример:

Пример запроса

## Event send
curl --request GET \
  --url 'https://localhost/template?id=<идентификатор клиента>' \
  --header 'Authorization: <token>'

Конфигурация

Распакуйте образы приложения из файла flows_inapp_adapter_{your_version}.tar.gz следующей командой:

docker load < flows_inapp_adapter_{your_version}.tar.gz

Создайте файл docker-compose.yaml со следующим содержимым:

version: '3'

services:
  inapp_adapter:
    image: {image_name}:{your_version}
    container_name: inapp_adapter
    network_mode: "host"
    restart: unless-stopped
    environment:
			- LOGGER_LEVEL=info
      - TOKEN=1234
      - PORT=3001
      - REDIS_CONNECTION=redis://host.docker.internal:6379
      - TEMPLATES_PROFILE_ID=osotw63688
      - URL_PARAMETER=original_client_user_id
    ports:
      - "8000:8000"

Описание параметров

image

Имя образа, который был распакован на предыдущем шаге, можно узнать командой docker images

container_name

Имя контейнера при запуске, рекомендуется оставить без изменения

restart

Политика рестарта процесса при остановке или ошибке, по умолчанию 'unless-stopped'

network_mode

Подробнее читайте в Особенности подключения к Redis.

Environment

BROKER_CONNECTION - адрес подключения к брокеру RabbitMQ.

PORT - порт для запуска HTTP-сервера.

ports

Параметр ports настраиваются только при установки свойства network_mode = 'bridge'. Если в network_mode задан 'host', то параметр ports не требуются.

Настройка портов, задается как "внешний_порт_для_сервера:порт_указаный в_свойстве_PORT"._

Данное свойство задает проброс внешнего порта на внутренний порт контейнера.

Переменные среды

Имя	Описание
`LOGGER_LEVEL`	Режим логирования, доступные значения: trace, debug, info, warn, error, fatal
`TOKEN`	Токен для обращения к API
`PORT`	Порт, на котором будет запущено приложение в контейнере. По умолчанию - 3000
`REDIS_CONNECTION`	Строка соединения к Redis
`TEMPLATES_PROFILE_ID`	Идентификатор профиля с данными в Accelera. Данный id можно найти на странице Audiences & Profiles.
`URL_PARAMETER`	Параметр из профиля, в котором записывается ссылка на получения шаблона Draw.

Запуск

Для запуска адаптера используйте следующую команду:

docker-compose -f {путь к вашему docker-compose файлу} up

Получить доступ к логам и проверить работоспособность адаптера можно командой:

docker logs -f inapp_adapter

Остановка

Для остановки адаптера используйте команду:

docker-compose -f {путь к вашему docker-compose файлу} down