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

Разделы настроек

В зависимости от типа инсталляции (через установщик или с помощью наших инженеров) настройки могут храниться в:

• /opt/gateway/configs на хосте или внутри Docker-контейнера oz-api

• /var/lib/docker/volumes/api_oz-api-config-vol/_data в случае стационарного установщика.

Основной файл настроек – config.py

Подключение к Postgres

DB_USER = 'имя пользователя'
DB_HOST = 'адрес сервера Postgres'
DB_PASS = 'пароль пользователя'
DB_NAME = 'название базы'

Путь к медиафайлам

Все входящие медиафайлы сохраняются в локальную папку, примонтированную к одному из мест в зависимости от установки:

• /opt/gateway/static на хосте или в Docker-контейнере

• /var/lib/docker/volumes/api_oz-api-static-vol/_data - в случае стационарного установщика

• любой указанный заранее путь

При большинстве сценариев интеграции медиафайлы доступны из внешней сети по прямым ссылкам с указанием случайно сгенерированных имён файлов.

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

PORT = 443
SCHEME = 'https'
HOST = 'api.globalbank.com'

Связка с Oz Bio / Liveness

OZ_SERVICE_TFSS_HOST = 'http://bio-server-name:8501/v1/'

Тайминги и ограничения

# количество попыток провести анализ при отказе Oz Bio
OZ_CELERY_RETRY_MAX_COUNT = 7
# промежуток между попытками
OZ_CELERY_RETRY_STEP = 30
# максимальное время ожидания одного анализа
OZ_ANALYSE_PROCESSING_EXPIRE_TIMEOUT = 15 * 60  # 15 минут
# максимальное время ожидания анализа API
OZ_ANALYSE_DELIVERY_EXPIRE_TIMEOUT = 60 * 60  # 1 час
# частота проверки просроченности анализа
OZ_ANALYSE_EXPIRE_BEAT_PERIOD = 1 * 60  # каждую минуту

# максимальное количество прикрепленных медиа
OZ_ATTACHMENT_MAX_COUNT = 10
# максимальный размер одного медиа
OZ_ATTACHMENT_MAX_SIZE = 10 * 1024 * 1024  # 10Mb

# количество секунд до истечения авторизационного токена
OZ_SESSION_TTL = 60 * 15  # 15 мин
# количество секунд до истечения сервисного токена
OZ_SESSION_LONGLIVE_TTL = 60 * 60 * 24 * 365 * 5  # 5 лет

# максимальный размер миниатюры в байтах
OZ_IMAGE_SIZE_THUMBNAIL = 300
# максимальная продолжительность видео в секундах
OZ_VIDEO_DURATION_MAX = 30