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

Установка по шагам

Для установки требуется любой стационарный (не виртуальный) сервер с ОС Linux. Свяжитесь с нами, чтобы получить архив с программой, и следуйте инструкции ниже.

1. Распакуйте архив

mkdir /opt/oz
cd /opt/oz
tar xzf oz-lic.tar.gz

2. Установите службу лицензирования

./LexFloatServer -p product.dat -c config.yml -i --service-name ozlic

На этом серверная установка окончена. Дальнейшая настройка и активация производится через Web-интерфейс на порту 8090.

3. Активируйте лицензию

Откройте в браузере страницу по адресу http://server:8090 и авторизуйтесь.

Зайдите в раздел Settings.

Онлайн-активация

Наиболее простой способ активировать сервер лицензирования – выполнить это онлайн.

Для этого достаточно ввести ключ и нажать ACTIVATE.

Офлайн-активация

При отсутствии интернета на сервере лицензирования вы можете выполнить активацию офлайн-способом.

Для этого нажмите SWITCH TO OFFLINE ACTIVATION.

Введите ключ и нажмите NEXT.

Затем нажмите DOWNLOAD REQUEST FILE.

Передайте нам файл offline_activation_request.txt . Мы в ответ направим вам код активации.

Введите этот код в окно для offline activation response и нажмите ACTIVATE.

В этом разделе вы найдете инструкции по установке решений Oz Forensics: как полной версии, так и версии Lite.

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

Системные метрики

1. С помощью команды ping убедитесь, что ко всем серверам имеется доступ.

2. Проверьте наличие свободного пространства на всех дисках – его должно быть 10% или более.

3. Проверьте, что сервера используют не более 90% оперативной памяти.

Внутренние метрики

1. Проверьте доступ к сервисам oz-api с помощью GET `/api/version` (так называемый health check). В случае успеха вернется код 200.

2. Проверьте доступ к сервисам oz-bio с помощью GET `/v1/models/inquisitor`. В случае успеха вернется код 200.

3. Проверьте, не истекла ли лицензия наoz-bio. Запустите в консоли следующий код:

curl -s -d '{"inputs": {"images_bytes": [{"b64": ""}]}}'  -X POST  http://localhost:8501/v1/models/inquisitor:predict | grep -c assertion

В случае успеха в консоли отобразится 1.

4. Проверьте, нет ли слишком больших задержек в последней серии анализов. Запустите код, указанный ниже, чтобы получить 90-й перцентиль длительность задержек в секундах.

docker exec -i --user postgres oz-api-pg psql -X -A -t -d gateway -c "select percentile_disc(0.9) within group(order by date_part('epoch', time_updated-time_created)) from gw_analyse_abstract where time_updated > current_timestamp - interval '10 minutes'"

В консоли отобразится результат, он должен быть меньше 20.

5. Проверьте, не растет ли очередь неоконченных анализов. Запустите код, указанный ниже, чтобы получить количество незавершенных анализов в очереди.

docker exec -i oz-api-rabbitmq rabbitmqctl list_queues | egrep -i '^tfss\s' | awk '{ print $2 }'

В консоли отобразится результат, он должен быть меньше 20.

Если любой из результатов не соответствует заявленному успешному, пожалуйста, свяжитесь с нами по адресу support@ozforensics.com.

Что это?

Стационарный установщик – это программа для установки модулей системы Oz Forensics на сервера заказчика с автоматическим внесением всех необходимых настроек с учётом индивидуальной топологии и требований заказчика.

Данный установщик предназначен для развёртывания ПО на сервера напрямую, под учетной записью администратора. Сервера, на которых будет работать ПО, могут иметь или не иметь (с некоторыми оговорками) прямого доступа к Интернету, на них должен быть установлен Linux и к ним должен иметься полный доступ по ssh.

Для установки в OpenShift и других оркестраторах, пожалуйста, обратитесь к нам.

Необходимые условия

Требования к серверам

Сервер для Oz Biometry / Liveness

• CPU: 16 ядер

• RAM: 24 Гб

• На диске: 80 Гб

Сервер для Oz API / WebUI / Web SDK

• CPU: 8 ядер

• RAM: 16 Гб

• На диске: 300 Гб

Пожалуйста, обсудите версию ОС с нашими инженерами.

sed -i 's/always/unless-stopped/g' /usr/lib/systemd/system/podman-restart.service
systemctl daemon-reload

Требования к Kubernetes (K8s)

Версия: 1.27.

Обязательные компоненты:

• Prometheus (версия Helm-чартов (kube-prometheus-stack) – 45.7.1),

• Nginx Ingress Controller (версия Helm-чартов – 4.7.1, репозиторий с чартами здесь),

• ClusterIssuers.

Опциональные компоненты:

• Любой Storage Class с поддержкой режима ReadWriteMany (RWX).

Требования к ресурсам узлов:

• Архитектура CPU: Intel

• CPU/RAM: аналогично требованиям к серверам.

Еси вы хотите настроить переменные чарта самостоятельно, обратитесь к нам.

Подготовка

1. Запросите список клиентских URL с соответствующими им сертификатами SSL.

2. Проверьте, что все сервера доступны по локальной сети.

3. Проверьте наличие доступа либо по SSH с авторизацией по паролю, либо с файлом-ключом и sudo без пароля.

4. Для установки мы рекомендуем использовать Docker или Podman. Если есть доступ в интернет, можно скачать и установить Docker или Podman автоматически.

   • Docker версии 19.03 и выше и Docker Compose версии 1.27 и выше (необходимо установить в /usr/sbin);

   или

   • Podman версии 4.4 и выше (с модулями netavark и aardvark-dns) и podman-compose.

5. Для установки балансировщика, если он есть в вашем инсталляционном пакете мы рекомендуем установить nginx версии 1.17.5 и выше. Для CentOS и Redhat вместо этого вы можете переключить SELinux в режим Permissive. Еще один вариант – доступ к интернету для скачивания и установки в автоматическом режиме.

6. Проверьте, что сервера имеют доступ к сервису лицензий https://api.cryptlex.com. Брандмауэр клиента не должен блокировать этот адрес.

7. Процессор сервера BIO должен поддерживать AVX флаги. Для проверки используйте команду lscpu | grep -E 'avx256|avx512' | wc -l. Ответ должен быть “1”.

8. Брандмауэр клиента не должен блокировать:

   • любые запускаемые скрипты или бинарные образы;

   • любые локальные порты для взаимодействия процессов (сети docker: 192.168.0.1/24, 192.168.10.0/24, 192.168.11.0/24, 192.168.12.0/24, 192.168.13.0/24);

   • порты 80, 8000, 8080, 8090 на сервере API server и порт 8091 на сервере BIO;

   • порт 5432 для установки Postgres.

Перед отправкой трафика на сервер API может потребоваться завершить соединение HTTPS и дешифровать трафик. Обычно это делается с помощью брандмауэра или других инструментов безопасности.

Важно: предупредите нас о любых нетипичных и/или неофициальных программах или сервисах, установленных на серверах.

Как получить установщик?

Закажите вашу персональную копию установщика с предварительно согласованным комплектом модулей для тестовой или продуктивной среды.

Комплект для быстрого ознакомления

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

Вам достаточно подготовить два сервера, отвечающие изложенным выше требованиям, и скачать комплект установки.

Как запустить установщик?

Для запуска вам потребуется компьютер с Windows или Linux. Системные требования:

• 1 Гб ОЗУ, 1 CPU, 3 Гб на диске

• Windows 10+ (рекомендовано)

• Linux 64-bit (требуется Python 3.7)

Подробную информацию по запуску смотрите ниже (на английском языке):

Подготовка серверов

1. Убедитесь, что системные характеристики серверов соответствуют рекомендуемым.

2. Убедитесь, что сервера доступны по локальной сети.

3. Убедитесь, что к серверам есть доступ по единой учетной записи по SSH c авторизацией по паролю или файлу-ключу и для данной записи доступен sudo без интерактивного ввода пароля.

4. Для установки модулей системы на серверах должен быть установлен Docker (версии >=19.03) и, желательно, Docker Compose (версии >=1.27) либо доступен Интернет для автоматического скачивания и установки.

5. Для установки балансировщиков сетевой нагрузки (только если это явно включено в вашу поставку) на серверах должен быть установлен nginx (версии >= 1.17.5), а также SELinux должен быть переведен в состояние permissive (относится только к CentOS и Redhat). Для автоматического скачивания и установки должен быть доступен Интернет.

Подготовка установщика

Скачайте и разархивируйте вашу копию установщика.

Внесите необходимые настройки в файл settings.yml. Ниже приведено описание некоторых важных настроек. В общем случае при установке требуется только заполнить блок авторизации и переменные.

Пожалуйста, обратите внимание: файл с настройками является вашей персональной копией и не подлежит передаче третьим лицам.

Настройки

# блок авторизации
auth:
  ssh_user: # логин пользователя
  use_sudo: yes # использовать ли sudo
  # полный путь к приватному ssh-ключу. опционально
  ssh_private_key: C:\\cygwin64\\home\\user\\.ssh\\id_rsa 

# блок переменных - может отличаться для вашей поставки
vars:
  # как правило, содержит IP адреса серверов по ролям
  api1: 130.193.58.196
  api2: 178.154.232.159
  bio1: 130.193.59.58
  bio2: 130.193.57.151
  text1: 178.154.232.69
  balancer: 84.201.145.209

  # а также логин и пароль пользователя API с ролью ADMIN
  common-login: demo@ozforensics.com
  common-password: 123456

# список серверов, как правило, использует значения переменных
# из блока выше и в правке не нуждается
servers:
  oz-api:
    - $api1
    - $api2
  oz-api-balancer: $balancer
  oz-webui:
    - $api1
    - $api2
  oz-webui-balancer:
  oz-webadapter:
    - $api1
    - $api2
  oz-webadapter-balancer: $balancer
  oz-bio:
    - $bio1
    - $bio2
  oz-bio-balancer: $balancer
  oz-text: $text1
  # если в этой строке ничего не указано, при генерации конфигурации API
  # будет использоваться хост сервиса докера, где развернута база данных
  oz-db:

# блок настроек
settings:
  # персональный лицензионный ключ
  license-key: "123456-123456-123456-123456-123456-123456"
  # локальный путь для хранения настроек на каждом сервере
  working-directory: /opt/oz

  # настройки докера
  docker-daemon:
    # подсеть для запуска контейнеров через docker
    bip: 192.168.0.1/24
    # подсети для запуска контейнеров через docker-compose
    default-address-pools:
      - base: 192.168.1.0/24
        size: 24

  # блок настроек Oz API
  oz-api:
    install: yes  # устанавливать ли компоненту
    install-statistic: no # устанавливать ли модуль статистики
    balancer: yes # устанавливать ли балансировщик
    # доменное имя для внешнего доступа к компоненте 
    domain_name:
    # SSL сертификат и ключ для HTTPS-доступа (опционально)
    domain_cert:
    domain_key:
    # путь для сохранения персональных медиа файлов
    media_path:
    # логин/пароль админской учётки на Oz API
    admin:
      login: $common-login
      password: $common-password
    # описание конфигурации смотрите в разделе знаний Oz API
    config:
    # сетевой порт доступа к компоненте 
    # (используется, если не указан SSL-сертификат, иначе 443)
    port: 80

  # блок настроек Oz Liveness Web Adapter
  # описание настроек, подобных Oz API, см. выше
  oz-webadapter:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # адрес http ресурса для автоматической пересылки
    # при попытке зайти по /
    redirect_url:
    config:
    port: 88

  # блок настроек Oz WebUI
  # описание настроек, подобных Oz API, см. выше
  oz-webui:
    install: yes
    balancer: yes
    domain_name:
    domain_cert:
    domain_key:
    # Логин/пароль технической учетной записи для настроек синхронизации
    admin:
      login: admin
      password: admin
    config:
    port: 80

  # Блок настроек базы данных для Oz API
  oz-db:
    # устанавливать ли Postgres вместе с установкой Oz API
    # если выбрано no, то используется внешняя служба Pоstgres
    # в обоих случаях адрес сервера берется из блока servers -> oz-db
    install: yes
    # master - пароль Postgres, если выбрана его установка
    psql_password: CHANGEME
    # имя создаваемой базы данных
    database: gateway
    # имя пользователя и пароль базы данных
    user_name: gateway_user
    user_password: CHANGEUSERPASS

  # Блок настроек компоненты Oz Bio (Liveness + Biometry)
  # описание настроек, подобных Oz API, см. выше
  oz-bio:
    install: yes
    balancer: yes
    # настройки и список моделей не предназначены для изменения
    # пользователем
    settings:
    models:

  # Блок настроек компоненты Oz Text
  oz-text:
    # устанавливать ли компоненту
    install: yes
    # прочие настройки менять не рекомендуется
    workers: 2
    group_check:
    auth:
      user_id:
      password:

Запуск

Вызовите командную строку с правами администратора. Перейдите в папку, куда вы до этого поместили разархивированный установщик (команда cd). Запустите процесс установки.

Для запуска на Windows:

oz-installer.cmd install [параметры]

Для запуска на Linux:

chmod +x oz-installer.sh
./oz-installer.sh install [параметры]

Список необязательных параметров:

• filename – имя файла с настройками (по умолчанию 'settings.yml')

• private_key – путь к приватному ssh-ключу (переопределяет соответствующую опцию настроек)

• key_password – пароль к ssh-ключу, если не указан, система попросит ввести его в консоли

• ssh_password – пароль ssh-пользователя

• --debug – выводит и логирует подробную информацию выполнения

Пример использования:

install.cmd filename=settings.prod.yml key_password=psyco --debug

Устранение неисправностей

В процессе установки вся информация записывается в файл process.log. При возникновении нештатных ситуаций при установке прикрепляйте этот файл к обращению.

Если установка была прервана по нештатной ситуации, то после разрешения проблемы она, как правило, может быть продолжена. Если продолжение невозможно, будьте готовы к сбросу серверов в изначальное состояние. Вы можете определить неисправность самостоятельно, если добавите к команде запуска параметр: --debug. Вы также можете обратиться к нам для уточнения информации.

Как использовать putty ppk файл для подключения

Для этого необходимо сначала извлечь private-часть ключа, а затем указать путь к этому файлу в разделе auth -> ssh_private_key

Что делать при docker-compose: команда не найдена

Такая ошибка может происходить в том случае, когда программа docker-compose была установлена самостоятельно для запуска установщика и при этом был выбран путь по умолчанию: /usr/local/bin

Для корректной работы создайте символическую ссылку:

ln -s /usr/local/bin/docker-compose /usr/sbin/docker-compose

Порядок установки

• Связаться с нами и скачать архив Docker-образа по ссылке, которую мы вам пришлем

• Загрузить образ в Dockerdocker load -i <path to image tar file>

• Запустить docker run -p {port}:80 ozforensics/oz-api-lite:{tag}

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

Параметры задаются переменными окружения при старте Docker-контейнера.

Допустимы следующие параметры:

• NUM_WORKERS – максимальное количество одновременно выполняемых анализов, определяется индивидуально. По умолчанию: 16.

• TF_ENABLE_ONEDNN_OPTS – ускорение. По умолчанию: 1, для процессоров AMD необходимо выставить 0.

Применение

Взаимодействие с биометрическим процессором реализовано на основе REST API по протоколу HTTPS.

Точка доступа к API

Базовый URL доступа к API: https://{hostname}/v1/face/pattern или https://{hostname}/v1/face/liveness в зависимости от используемого метода (см. примеры).

Где:

• {hostname} – имя хоста и порт сервера развернутого биометрического процессора.

Пример: localhost/v1/face/pattern

API поддерживает следующие типы контента запроса (HTTP-заголовок «Content-Type»):

• «multipart/form-data»;

• «application/octet-stream»;

• «image/jpeg» или «image/png»;

Используемые коды ответов HTTP

В этом разделе собрана информация о том, как управлять процессом работы с продуктами Oz Forensics со стороны клиента.

Установка

Установить SDK можно двумя способами: либо инженеры Oz Forensics делают все вручную, либо используется . В последнем случае потребуется вовлечение ваших специалистов. При установке Oz Web SDK Web Adapter сгенерирует нужные файлы Web Plugin: такие, как файл со стилями (ozliveness.css) и основной скрипт плагина (plugin_liveness.php).

Лицензирование

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

1. Распакуйте полученный файл.

2. Скопируйте JSON-файл лицензии на хост, где развернут контейнер из образа ozforensics/oz-webliveness-dev:latest.

Пример

• -i ~/ozforensics/keys/id_rsa-test-hostname-vm – путь к публичному ssh-ключу хоста

• 0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json – файл лицензии в формате JSON.

• user – имя пользователя на хосте.

• hostname – псевдоним хоста.

• /opt/oz/web-sdk – каталог на хосте, где развернут контейнер Web SDK.

3. Замените файл лицензии.

Пример

4. Перезапустите контейнер Web SDK.

Пример

• web-sdk – название контейнера, созданного из образа ozforensics/oz-webliveness-dev:latest.

Проверьте, как установилась лицензия: например, пройдите по доменному имени хоста и выполните действие Liveness -> Simple selfie.

Далее при каждом запуске Web SDK система будет проверять валидность лицензии.

Возможные ошибки лицензирования

• WA_CORS_ORIGINS – от каких источников принимать запросы. Значение по умолчанию отсутствует. Если переменная не задана, то CORS headers отключены, т.е. внутри контейнера Web SDK никакие cors headers не будут добавлены!

• WA_CORS_METHODS(необязательно) – Методы HTTP, которые могут использоваться. Если значение переменной не задано, она принимает значение по умолчанию: 'GET, POST, OPTIONS'. Если переменная не указана, можно использовать все методы.

• WA_CORS_HEADERS(необязательно) – Заголовки HTTP, которые могут использоваться. Если значение переменной не задано, она принимает значение по умолчанию: 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type'. Если переменная не указана, можно использовать все заголовки.

Пример настройки CORS headers через переменные окружения:

Некоторые параметры файла конфигурации можно переопределять с помощью переменных окружения. В некоторых случаях это позволяет обойтись без редактирования файла конфигурации, например при использовании WebSDK в режиме Lite.

• WA_ARCHITECTURE – переопределяет параметр architecture

• WA_API_URL – переопределяет параметр api_url

Пример использования переменных окружения при запуске docker-образа Web SDK в режиме Lite.

В этом разделе описано содержимое файла конфигурации /core/app_config.json.

• use_for_liveness – опция применяется при использовании WebSDK операторами банка для съемки клиентов. Если use_for_liveness = true, при съемке лица на мобильных устройствах выбирается тыловая камера, на десктопе отключается флип; отключается обводка овала;

• preinit – параметр включает предварительную загрузку библиотек и инициализацию, уменьшая время использования plugin. Параметр необязательный, значение по умолчанию off – загрузка скриптов и инициализация происходит после открытия plugin и вызова функции OzLiveness.open(). В таком режиме plugin не создает нагрузки на сайт (приложение), на котором он установлен, но сам plugin может открываться долго из-за описанных выше процессов. Значение script – предварительная загрузка только библиотек плагина. Значение full – предварительная загрузка библиотек и инициализация процесса определения лица.

• architecture – выбор архитектуры, в которой используется WebSDK. Параметр необязательный, значение по умолчанию normal.

  • normal для включения полной версии Oz API;

  • lite для использования ;

  • capture – для работы с бэкэндом клиента напрямую. В этом случае возможно распространение Oz Liveness Web Plugin только через статические файлы, без адаптера (работает с версии 0.7.4);

• api_url – адрес сервера Oz API, текстовый параметр;

• api_token – токен для доступа к Oz API, текстовый параметр;

• api_use_token – параметр, определяющий источник получения системой токена для доступа к Oz API. Возможные значения = config, client.

  • Если установлено значение client, то токен для доступа к Oz API ожидается от JS-плагина;

  • Если установлено значение config, то токен берется из параметра api_token файла /core/app_config.json.

• video_actions_list – блок используемых в системе тегов файлов видео, текстовый массив. .

• photo_actions_list – блок используемых в системе тегов файлов фотографий, текстовый массив. .

• actions_default_importance – возможность при запуске анализа переопределить массив действий из WEB-плагина. Возможные значения = true, false;

  • Если установлено true, то адаптер будет использовать массив действий из конфигурационного файла.

  • Если установлено false, то адаптер будет использовать массив действий, переданный из браузера методом open(options).

• actions_default – массив действий. Доступные параметры:

  • video_count – количество передаваемых видеофайлов, числовой параметр;

  • photo_front – наличие фронтальной страницы документа. Возможные значения = true, false;

  • photo_back – наличие оборотной страницы документа. Возможные значения = true, false.

• analyses – блок настройки запуска анализов. Доступные параметры:

  • quality – запуск анализа Oz Liveness. Возможные значения = true, false;

  • biometry – запуск анализа Oz Biometry. Возможные значения = true, false;

  • documents – запуск анализа Oz Text. Возможные значения = true, false;

  • collection_ids (с версии 1.4.0) – массив идентификаторов коллекций для анализа по черному списку.

• extract_best_shot – параметр, определяющий необходимость добавления в результат анализа прямой ссылки на лучший кадр, извлеченный из видео. Возможные значения = true, false. Если установлено true, в ответе в output_images (results_media) будет ссылка на извлеченное изображение;

• result_mode – параметр, определяющий содержание ответа сервера с результатами проверки. Возможные значения:

  • safe – возвращается только состояние анализов (завершены или еще нет);

  • status – возвращаются результаты выполнения анализов;

  • folder – то же самое, что status, но дополнительно возвращается folder_id;

  • full – возвращается полный ответ Oz API по анализам в формате JSON.

• result_codes – блок кодов ответа с комментариями.

• delete_old_sessions – если установлено true, старые сессии удаляются.

• delete_old_sessions_offset_minutes – если установлено, старые сессии удаляются с соответствующим смещением в минутах.

• video_required_actions_list – массив обязательных действий, которые снимающему нужно воспроизвести. См. .

• save_lossless_frame– если true, исходный кадр сохраняется без сжатия.

• debug (с версии 1.1.0) – при значении true дает возможность открыть страницу /debug.php, на которой размещена информация о текущих конфигурации и лицензии.

• load_3d_mask (с версии 1.3.1) – если установлено true, загружает модели для обработки видео, снятого с помощью 3D-маски. Значение по умолчанию – false; в этом случае модель не подгружается, и 3D-маску использовать нельзя (параметр enable_3d_mask игнорируется).

• enable_3d_mask (с версии 1.3.1) – включает использование 3D-маски при съемке вместо овала. Параметр работает только в случае load_3d_mask= true; значение по умолчанию – false.

• master_license_signature (с версии 1.3.1) – подпись мастер-лицензии; по умолчанию null.

• results_polling_interval (с версии 1.4.0) – интервал опроса для получения результатов анализов, мс; значение по умолчанию — 1000.

• get_user_media_timeout (с версии 1.5.0) – определяет время, по истечении которого отобразится подсказка о том, как получить доступ к камере, если к тому моменту доступ не был получен; default_default для всех браузеров и android_facebook для Facebook браузеров.

• disable_adapter_errors_on_screen (с версии 1.5.0) – выключает отображение ошибок API в модальных окнах, оставляя возможность их просмотра только в коллбэке on_error. Значение по умолчанию – False.

Настройка Oz Liveness WEB Adapter производится путем изменения конфигурационного файла, расположенного на сервере Oz Liveness WEB Adapter по пути /core/app_config.json

Для Angular и React нужно заменить https://web-sdk.sandbox.ozforensics.com в index.html.

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

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

• /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