В этом разделе собраны инструкции по интеграции серверных проверок Liveness.
Как интегрировать серверную проверку Liveness в ваше Web-приложениеКак интегрировать серверную проверку Liveness в ваше мобильное приложениеКак провести проверку медиафайла на Liveness без использования фронтенда OzИз этой статьи вы узнаете, как интегрировать Oz Liveness Web SDK в клиентское Web-приложение: для съемки видео с лицом и дальнейшей его проверки на сервере.
Преимущества Oz Liveness Web SDK:
Готовый интерфейс для съемки видео, который легко встроить в приложение клиента.
Высокое качество видео, которое обеспечивает точность проверки Liveness.
Возможность обнаружения и презентационных, и инъекционных атак. Инъекционная атака – попытка выдать за свежеснятое видео другое, снятое ранее с помощью виртуальной камеры.
Возможность использования как SaaS-модели, так и локальной установки – с теми же функциями, но без необходимости слать какие-либо данные в облако.
«Под капотом» Web SDK взаимодействует с OZ API.
Мы рекомендуем начать с SaaS-модели и затем перейти к локальной установке – чтобы настроить бесшовную интеграцию Web SDK с вашими фронтендом и бэкендом. В этой инструкции приводятся шаги, благодаря которым процесс интеграции будет простым и ясным.
Получите доступ к персональной копии Web Adapter
Передайте нам информацию о доменных именах тех страниц, откуда планируется вызывать Web SDK, а также адрес электронной почты для создания аккаунта администратора. Пример:
Доменные имена:
www.yourbrand.com
www.yourbrand2.com
Электронная почта:
ivan.ivanov@yourcompany.com
Мы направим вам ссылки и логин с паролем для дальнейшей интеграции и использования Web SDK.
Логин: ivan.ivanov@yourcompany.com
Пароль: …
API: https://sandbox.ohio.ozforensics.com
Web-консоль: https://sandbox.ohio.ozforensics.com
Web Adapter: https://web-sdk.cdn.sandbox.ozforensics.com/your_company_name/
Добавьте Web Plugin на вашу страницу
В HTML-коде страницы разместите следующее. web-adapter-url
необходимо заменить на полученную от нас ссылку.
Реализуйте собственную логику для использования Web Plugin
Добавьте код, который будет запускать плагин и обрабатывать результаты:
Пожалуйста, обратите внимание: в целях безопасности мы рекомендуем настроить логику принятия решений на стороне вашего бэкенда. Более детальную информацию и примеры кода вы можете найти здесь.
Шаги выше помогут вам в базовой интеграции Web SDK в ваше веб-приложение. Чтобы получить доступ к снятым видео и результатам анализов, воспользуйтесь веб-консолью или API-запросами (получение видео в MP4 и результатов анализов).
Дальнейшие шаги описаны в руководстве разработчика по Web Plugin:
Настройка внешнего вида плагина
Добавление дополнительного языка
Настройка поведения плагина
Настройка параметров и коллбэк-функций
Рекомендации по безопасности
Образец кода Oz Liveness Web SDK находится здесь. Чтобы все работало корректно, нужно заменить <web-adapter-url>
на полученную от нас ссылку на Web Adapter.
Для Angular и React нужно заменить https://web-sdk.sandbox.ohio.ozforensics.com
в index.html.
Из этой статьи вы узнаете, как интегрировать Oz Liveness Mobile SDK в клиентское мобильное приложение: для съемки видео с лицом и дальнейшей его проверки на сервере.
Oz Liveness Mobile SDK – это:
Готовый интерфейс для съемки видео, который легко встроить в приложение клиента.
Высокое качество видео, которое обеспечивает точность проверки Liveness.
«Под капотом» Oz SDK взаимодействует с OZ API.
Для интеграции необходимо связаться с нами для получения всех нужных ссылок и доступов:
Логин: ivan.ivanov@yourcompany.com
Пароль: …
API: https://sandbox.ohio.ozforensics.com
Web-консоль: https://sandbox.ohio.ozforensics.com
Для работы Oz Liveness Mobile SDK нужна лицензия, которая привязывается к bundle_id приложения, например com.yourcompany.yourapp
. Тестовую лицензию на месяц вы можете оформить самостоятельно на нашем веб-сайте, если вам требуется лицензия на более длительный срок – свяжитесь с нами.
Мы также рекомендуем использовать наш сервис логирования – телеметрию. Записи телеметрии помогают в расследовании деталей атак. Для пользователей Oz API логирование подключается автоматически. Для локальных установок мы предоставим вам необходимые учетные данные.
В build.gradle проекта добавьте строки:
В build.gradle модуля добавьте строки:
Переименуйте файл лицензии в forensics.license и поместите его в папку res/raw в вашем проекте.
Вам потребуются полученные от нас логин, пароль и адрес API-сервера.
На стадии продакшна рекомендуется использовать в коде не логин и пароль, а полученный с помощью метода авторизации на их основе токен доступа access_token
. Передайте токен в приложение:
Для начала съемки используйте метод startActivityForResult
:
Для получения готового видео используйте onActivityResult
:
Готовые видео содержатся в объекте sdkMediaResult
.
Для запуска анализов используйте код ниже. mediaList
– массив объектов, полученных из sdkMediaResult
или извне (если вы снимали видео без использования нашего SDK).
Установите OZLivenessSDK через CocoaPods. Чтобы встроить SDK в проект Xcode, в Podfile добавьте:
Переименуйте файл лицензии в forensics.license и поместите его в проект.
Вам потребуются полученные от нас логин, пароль и адрес API-сервера.
На стадии продакшна рекомендуется использовать в коде не логин и пароль, а полученный с помощью метода авторизации на их основе токен доступа access_token
. Передайте токен в приложение:
Создайте контроллер, который будет снимать видео:
В делегате используйте протокол OZLivenessDelegate:
Для запуска анализов используйте AnalysisRequestBuilder
. Метод run
«под капотом» обратится к Oz API.
Шаги выше помогут вам в базовой интеграции наших мобильных SDK в ваше приложение. Чтобы получить доступ к снятым видео и результатам анализов, воспользуйтесь веб-консолью или API-запросами.
В руководстве разработчика вы также найдете инструкции по настройке внешнего вида SDK и список методов SDK как для iOS, так и для Android:
Образец кода для Android
Образец кода для iOS
Руководство разработчика Android
Oz API – это API для распознавания лиц: как для проверки Liveness, так и для биометрической проверки, то есть сравнения лиц между собой.
Ключевые преимущества Oz API:
Сохранение данных – ваши медиафайлы и анализы хранятся для будущего использования, пока вы самостоятельно их не удалите
Возможность работать и с фото, и с видео
Асинхронность анализов
Безопасная аутентификация
Гибкая настройка уровней доступа
Основная сущность в Oz API – это папка: в папку вы можете загружать медиафайлы, запускать для них анализы и получать результаты не только для отдельных анализов, но и для папки в целом.
Здесь мы приводим пошаговую инструкцию по проведению проверки Liveness для фото или видео лица, которое вы уже сняли с помощью бэкенда Oz.
Создание папки
Загрузка медиафайла в папку
Проверка Liveness
Получение результатов
Для вашего удобства и повышения точности анализов мы рекомендуем использовать для съемки медиа наши Web или Mobile SDK. Как это сделать, описано здесь:
Чтобы начать, вам понадобятся логин и пароль. Напишите нам, и вы отправим вам всю необходимую информацию, включая ссылки:
Логин: ivan_ivanov@yourcompany.com
Пароль: …
API: https://sandbox.ohio.ozforensics.com
Web Console: https://sandbox.ohio.ozforensics.com
Со всеми методами Oz API можно ознакомиться здесь: коллекция Postman.
Мы рекомендуем использовать токен доступа вместо логина и пароля, так как это более безопасно. Вызовите метод POST /api/authorize/auth
. В теле запроса укажите логин и пароль
В ответе вам придет токен доступа. В дальнейшем его нужно будет указывать в поле X-Forensic-Access-Token.
Внимание: если вы используете API версии 5.0.0 или новее, пропустите этот шаг.
В версии 4.0.8 и ниже проверка Oz Liveness может производиться либо по видео, либо по последовательности кадров в архиве. Таким образом, если вы хотите запустить проверку по одной фотографии, ее необходимо добавить в ZIP-архив. Oz API будет обрабатывать этот архив так же, как видео. Обратите внимание: теги к этому архиву необходимо указывать из списка тегов для видео.
Чтобы создать папку и добавить в нее ваши фото и видео, вызовите метод POST /api/folders/
и добавьте медиафайлы в тело запроса.
В поле payload
укажите следующие теги:
В случае успеха вернется код 201. В ответе будет идентификатор папки folder_id
– он понадобится в дальнейшем.
Для запуска анализа вызовите метод POST /api/folders/{{folder_id}}/analyses/
и укажите в нем folder_id из предыдущего шага. В теле запроса укажите анализ Liveness (Quality).
Метод вернет analyse_id
, который потребуется на следующем шаге.
Раз в секунду отправляйте запрос GET /api/analyses/{{analyse_id}}
с полученным ранее analyse_id
, пока состояние анализа не изменится с PROCESSING
на какое-либо другое. Когда анализ завершится, вы сможете оценить результаты:
качественные – в resolution (SUCCESS
или DECLINED
).
количественные – в results_media[0].results_data.confidence_spoofing. confidence_spoofing
; они варьируются от 0.0 до 1.0, где 0.0 означает, что на фото или видео реальный человек, а 1.0 – что система обнаружила спуфинг-атаку.
Коллекция Postman для описанных в статье шагов:
Шаги выше помогут вам выполнить Liveness-проверку через Oz API. Чтобы получить доступ к снятым видео и результатам анализов, воспользуйтесь веб-консолью или API-запросами.
Детальную информацию о том, как применять инструменты Oz API, вы можете найти в руководстве разработчика.