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

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

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

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

val apiService = OzForensicsAPI.create(BASE_URL)ko

OzForensicsAPI apiService = OzForensicsAPI.Factory.create(BASE_URL);

Класс OzForensicsService

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

val service = OzForensicsService(BASE_URL, ACCESS_TOKEN)

OzForensicsService service = OzForensicsService(BASE_URL, ACCESS_TOKEN);

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

service.auth(EMAIL, PASSWORD, listener)

service.auth(EMAIL, PASSWORD, listener)

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

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

Данные для отправки на анализ находятся в объекте 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>) { /*your code to handle analysis result*/ }
            override fun onError(error: OzException) { /*your code to handle analysis error*/ }
        }
        val analysisCancelable = OzLivenessSDK.uploadMediaAndAnalyze(
            mediaList,
            listOf(OzAnalysis.QUALITY, OzAnalysis.BIOMETRY),
            statusListener
        )

StatusListener<List<OzAnalysisResult>> statusListener = new StatusListener<List<OzAnalysisResult>>() {
            @Override public void onStatusChanged(@Nullable String s) { /*your code for showing status message*/ }
            @Override public void onSuccess(List<OzAnalysisResult> result) { /* your code to handle analysis result */ }
            @Override public void onError(@NonNull OzException e) { /* your code to handle analysis error */ }
        };
        Cancelable analysisCancelable = OzLivenessSDK.INSTANCE.uploadMediaAndAnalyze(
            mediaList,
            Arrays.asList(OzAnalysis.QUALITY, OzAnalysis.BIOMETRY),
            statusListener
        );

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

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

OzLivenessSDK.runOnDeviceLivenessAnalysis(mediaList)
OzLivenessSDK.runOnDeviceBiometryAnalysis(mediaList)

OzLivenessSDK.INSTANCE.runOnDeviceLivenessAnalysis(mediaList);
OzLivenessSDK.INSTANCE.runOnDeviceBiometryAnalysis(mediaList);

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

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

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

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

Это руководство поможет вам разобраться, как работать с приложением 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 вам нужно выбрать один из жестов для подтверждения того, что вы – реальный живой человек. Это такие жесты как:

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

• Селфи

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

• Моргание

• Улыбка

• Поднять голову

• Опустить голову

• Повернуть голову налево

• Повернуть голову направо

• Комбо (комбинация из нескольких жестов)

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

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

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

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

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

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

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

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

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

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

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

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

Biometry

Liveness