В этом разделе содержится документация по вышедшим из общего употребления версиям Android и iOS SDK.

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

Анализ на сервере

Данные для отправки на анализ находятся в объекте results (см. выше), полученном после съемки и записи видео. Загрузите их на сервер и инициируйте запуск необходимых анализы с помощью Oz API. См. также сценарии использования.

Для простого сценария взаимодействия с Oz API можно использовать метод OZSDK.analyse как описано ниже.

OZSDK.analyse(
  results: results,
  analyseStates: [.quality],
  fileUploadProgress: { (progress) in
  
  }
) { (resolution, error) in
  
}

В блоке completion | resolution будет содержаться результат назначенного анализа, включающий в себя status (статус анализа), type (тип анализа) и folderID (id папки Oz API).

Для проведения комплексного анализа с видео и фотографиями документов используется метод OZSDK.documentAnalyse:

В блоке resolutions будет содержаться результат назначенного анализа (аналогично OZSDK.analyse), а в folderResolutionStatus – общий статус анализов для папки.

И для документов, и для проверки лица вы также можете воспользоваться методом OZSDK.uploadAndAnalyse:

В блоке resolution будет содержаться результат назначенного анализа (аналогично OZSDK.analyse и OZSDK.documentAnalyse).

Анализ на устройстве

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

Biometry

Liveness

С февраля 2021 года мы запускаем новую документацию, куда вошли переработанные статьи из прежней документации и добавились новые инструкции. Мы продолжаем развивать новую версию и постоянно ее обновляем, чтобы наши клиенты и посетители сайта имели возможность ознакомиться с самыми актуальными статьями.

Если вы начали внедрять наши продукты до февраля 2021 года и с тех пор ничего не меняли, прежняя версия документации доступна для вас по этой .

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

Retrofit API-интерфейс

SDK содержит интерфейс IOzForensicsAPI с описанием сетевых вызовов к API, который можно использовать для создания инстанса Retrofit.

Этот интерфейс использует gson-converter и оперирует классами из пакета com.ozforensics.liveness.sdk.api.model.

Кроме того в этом интерфейсе определен статический метод для создания инстанса Retrofit по умолчанию (без логирования, интерцепторов и прочего, таймауты 15 секунд), который будет обращаться к серверу по заданному адресу:

Класс OzForensicsService

SDK содержит класс «OzForensicsService», использующий Retrofit-инстанс из IOzForensicsAPI.create(). Этот класс обертывает сетевые вызовы из Retrofit-интерфейса и учитывает наличие токена. При выполнении запроса auth класс автоматически сохраняет для себя токен, кроме того, выполняет сетевые запросы, добавляя необходимую метаинформацию там, где это необходимо (создание папки, выгрузка медиа на анализ). Вызовы методов этого класса – асинхронные (используется интерфейс StatusListener<>) Получить экземпляр класса можно следующим образом:

Если параметр TOKEN установлен null, то для выполнения вызовов к API (кроме auth) сначала необходимо выполнить авторизацию:

После удачного запроса будет выполнен onSuccessCallback, в который будет передан AuthResponse c access-токеном.

Продолжительность анализов

График показывает продолжительность выполнения анализов по их типам в зависимости от количества произведенных анализов. Вместе с общим количеством отображается количество по времени исполнения анализов: минимальное, среднее арифметическое и максимальное время выполнения анализа.

Опции графика

• Все анализы

• Любой анализ

• Черный список

• Биометрия

• Живость

Отображается на вкладке Производительность. Доступные варианты отображения: линейный и круговой графики.

Это руководство поможет вам разобраться, как работать с приложением Oz Liveness. Вы сможете протестировать наши алгоритмы и оценить их точность на вашей собственной выборке медиафайлов. Свяжитесь с нами, чтобы получить логин и пароль для доступа к приложению, а затем скачайте Oz Liveness на телефон. Доступны версии для iOS и Android.

Установка

iOS

Чтобы протестировать приложение для iOS, вам понадобится приложение TestFlight. Скачайте его из App Store: . Затем установите наше приложение: . Коснитесь иконки приложения, чтобы запустить его. При первом входе вам нужно будет ввести полученные от нас логин и пароль. Проверьте, что в поле Адрес API указано следующее: “https://api.sandbox.ozforensics.com/”. Нажмите кнопку Войти. Загрузится экран Сценариев.

Android

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

Когда дистрибутив скачается, запустите его. После установки приложения коснитесь его иконки – загрузится экран Сценариев.

В правом верхнем углу нажмите кнопку Профиль (с изображением человека). На новом экране введите свой логин и пароль. Проверьте, что в поле Сервер указано следующее: “https://sandbox.ohio.ozforensics.com/”. После ввода вы опять окажетесь на экране Сценариев.

Для смены пользователя зайдите в Профиль и нажмите Выйти, затем введите нужную пару логин + пароль.

В профиле вы также можете:

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

• выбрать, где проводить анализ – на сервере или на устройстве

• проверить текущую версию приложения и SDK

Работа с приложением

Демо-приложение предусматривает три сценария работы:

• Регистрация нового клиента (онбординг): клиент делает фото своих документов и селфи (фотографию / видео своего лица). Затем система сверяет извлеченные из медиафайлов биометрические шаблоны. Сценарий может использоваться, например, для регистрации где-либо.

• Биометрическая проверка: клиент делает селфи, затем система сравнивает это селфи с изображениями из базы данных. Таким образом можно, например, подтверждать транзакции, получать доступ куда-либо, сообщать о начале рабочего дня.

• Liveness – проверка “живости”, клиент делает селфи, и система подтверждает, что на этом селфи действительно реальный живой человек в сознании. Это сценарий защиты от спуфинга – цифрового мошенничества.

Регистрация нового клиента (онбординг)

Загрузите раздел Регистрация нового клиента (онбординг).

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

Подтвердите использование фотографии документа нажатием на знак галочки в правом верхнем углу. Приложение предложит вам сделать селфи для сверки с документом. Следуйте инструкциям на экране.

Когда обе фотографии будут сделаны, приложение отправит их на анализ, и вскоре вы получите результаты. Если лица на документе и селфи совпадают, вы получите сообщение “Регистрация прошла успешно”. Если в процессе возникли какие-либо проблемы (лица не совпадают, документы не распознаны, вместо лица маска или еще что-либо), вы получите сообщение “Мы с Вами свяжемся”.

Биометрическая проверка

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

В разделе Биометрическая проверка коснитесь кнопки Выбрать фото. На этом этапе вы выбираете референсное изображение – то, с которым будет сверено ваше селфи. Сделайте новое фото или выберите одну из фотографий в своей галерее. Затем коснитесь кнопки Сверить лицо. Следуйте подсказкам на экране.

Если лица совпадают, вы увидите сообщение “Аутентификация прошла успешно”. Если лица не совпадают, система выведет предупреждение.

Liveness

В разделе Liveness вам нужно выбрать один из жестов для подтверждения того, что вы – реальный живой человек. Это такие жесты как:

• Однокадровый

• Селфи

• Сканирование

• Моргание

Если проверка прошла успешно, вы увидите сообщение “Аутентификация прошла успешно”. Если лица не совпадают, система выведет предупреждение.

Все фото и видео, которые вы снимаете, можно позже найти в веб-консоли*. Инструкция по тому, как ей пользоваться, находится здесь: .

*Существует также возможность делать анализы на устройстве без отправки данных на сервер. Чтобы включить эту опцию, зайдите в Профиль и измените Вид анализа в разделе настроек на На устройстве. Теперь анализы будут проводиться прямо на вашем смартфоне. Это более быстрый и безопасный способ проверки, с одной стороны, с другой – проверка на сервере более точная, кроме того, данные после серверных проверок сохраняются, что позволяет и далее с ними работать по необходимости.

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

• Связаться с нами и скачать архив 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

Анализ на сервере

Данные для отправки на анализ находятся в объекте sdkMediaResult, полученном после съемки и записи видео. Загрузите их на сервер и инициируйте запуск необходимых анализов с помощью Oz API. См. сценарии использования. Для простого сценария взаимодействия с Oz API можно использовать метод uploadMediaAndAnalyze, как описано ниже.

val statusListener = object: StatusListener<List<OzAnalysisResult>> {
            override fun onStatusChanged(status: String?) { /*your code for showing status message*/ }
            override fun onSuccess(result:List <OzAnalysisResult>) { 

StatusListener<List<OzAnalysisResult>> statusListener = new StatusListener<List<OzAnalysisResult>>() {
            @Override public void onStatusChanged(@Nullable String s) { /*your code for showing status message*/ }
            @Override 

Анализ на устройстве

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

Состояние установленной биометрической системы 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.

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

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

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

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

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

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

Что это?

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

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

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

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

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

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

• CPU: 16 ядер

• RAM: 32 Гбайт

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

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

• CPU: 8 ядер

• RAM: 16 Гбайт

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

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

Требования к 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 автоматически.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Настройки

Запуск

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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