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.

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

Данные для отправки на анализ находятся в объекте 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:

OZSDK.documentAnalyse(
  documentPhoto: DocumentPhoto(front: frontDocumentURL, back: backDocumentURL),
  results: results,
  scenarioState: { (state) in
  
  }, fileUploadProgress: { (progress) in

  }
) { (folderResolutionStatus, resolutions, error)

}

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

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

OZSDK.uploadAndAnalyse(results: results,
                    documentPhoto: DocumentPhoto(front: frontDocumentURL, back: backDocumentURL),
                    analysisTypes: [.quality],
                    metadata: nil,
                    scenarioState: { state in },
                    fileUploadProgress: { progress in }) { status, resolution, error in }) 

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

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

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

Biometry

OZSDK.runOnDeviceBiometryAnalysis(firstResult: firstResult, secondResult: secondResult, completion: { status, error in
//show result
})

Liveness

OZSDK.runOnDeviceLivenessAnalysis(results: results, completion: {status, error in 
//show result
})