Переход на OzCapsula

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

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

Перед началом миграции проверьте, что все компоненты обновлены до минимально необходимых версий:

• API: 6.4.1.

• Web SDK: 1.9.2.

• Нативные SDK (iOS / Android): 8.22.

Более старые версии несовместимы с новой реализацией процесса захвата и анализа видео.

Мы рекомендуем обновлять все компоненты одновременно.

Изменения в аутентификации

Для каждой сессии съемки теперь необходим session_token, который нужно запросить у бэкенда.

• Токен нужно получить до начала съемки видео.

• Он привязан к конкретной сессии и контейнеру.

• Срок жизни токена ограничен.

Что нужно сделать:

• Реализовать на бэкенде запрос для получения session_token.

• Явно передавать токен при запуске съемки.

Изменения в процессе съемки и обработки видео

До контейнера (Legacy Flow)

1. Запускается съемка.

2. Видео снято.

3. Медиафайл вместе с необходимыми данными отправляется в Oz API – напрямую или через ваш бэкенд.

С контейнером (новый флоу)

1. С бэкенда запрашивается session_token.

2. Создается контейнер, куда добавляются session_token и при необходимости дополнительные данные (например, метаданные), после чего запускается съемка видео.

3. SDK снимает видео, упаковывает его в контейнер из пункта 2 и возвращает зашифрованный файл.

4. Зашифрованный файл отправляется в Oz API — напрямую или через ваш бэкенд.

Действия по миграции

API

• Обновите до v6.4.1-40 или выше.

• Измените Content-Type отправляемых данных на application/octet-stream.

• Для Instant API получите приватный и публичный ключи – подробнее здесь.

Web SDK

• Обновите до v1.9.2 или выше.

• Убедитесь, что бэкенд поддерживает session_token.

• В конфигурационном файле задайте use_wasm_container: true и api_use_session_token: api или client – подробнее в этой статье.

• Обновите инициализацию: токен должен передаваться явно.

• Если используется тип архитектуры capture, убедитесь, что на бэкенд и далее нам передаётся blob-объект (application/octet-stream).

Мобильные SDK

• Обновите до v8.22 или выше.

• Убедитесь, что бэкенд поддерживает session_token.

• Реализуйте новые интерфейсы, описанные ниже.

Android

1

Запуск экрана съемки

Для контейнера

val sessionToken: String = getSessionToken()
val captureRequest = CaptureRequest(
    listOf(
        AnalysisProfile(
            Analysis.Type.QUALITY,
            listOf(MediaRequest.ActionMedia(OzAction.Blank)),
        )
    )
)
val intent = OzLivenessSDK.createStartIntent(captureRequest, sessionToken)
startActivityForResult(intent, REQUEST_LIVENESS_CONTAINER)

Для версий до контейнера

2

Delegate

Для контейнера

override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
    super.onActivityResult(requestCode, resultCode, data)
    if (requestCode == REQUEST_LIVENESS_CONTAINER) {
        when (resultCode) {
            OzLivenessResultCode.SUCCESS -> runAnalysis(OzLivenessSDK.getContainerFromIntent(data))
            OzLivenessResultCode.USER_CLOSED_LIVENESS -> { /* user closed the screen */ }
            else -> {
                val errorMessage = OzLivenessSDK.getErrorFromIntent(data)
                /* show error */
            }
        }
    }
}

Для версий до контейнера

3

Запуск анализов

Для контейнера

private fun runAnalysis(container: DataContainer?) {
    if (container == null) return

    AnalysisRequest.Builder()
        .addContainer(container)
        .build()
        .run(
            { result ->
                val isSuccess = result.analysisResults.all { it.resolution == Resolution.SUCCESS }
            },
            { /* show error */ },
            { /* update status */ },
        )
}

Для версий до контейнера

iOS

1

Запуск экрана съемки

Для контейнера

getSessionToken() { sessionToken in
            DispatchQueue.main.async {
                do {
                    let action:OZVerificationMovement = .selfie
                    let mediaRequest = MediaRequest.action(action)
                    let profile = AnalysisProfile(mediaList: [mediaRequest],
                                                  type: .quality,
                                                  params: [:] )
                    let request = CaptureRequest(analysisProfileList: [profile], cameraPosition: .front)
                    let ozLivenessVC = try OZSDK.createMediaCaptureScreen(self, request, sessionToken: sessionToken)
                    self.present(ozLivenessVC, animated: true)
                } catch let error {
                    print(error.localizedDescription)
                }
            }
        }

Для версий до контейнера

2

Delegate

Для контейнера

extension ViewController: LivenessDelegate {
    func onResult(container: DataContainer) {
    }
    
    func onError(status: OZVerificationStatus?) {
    }
}

Для версий до контейнера

3

Запуск анализов

Для контейнера

func onResult(container: DataContainer) {
  let analysisRequest = AnalysisRequestBuilder()
  analysisRequest.addContainer(container)
  analysisRequest.run(
            statusHandler: { status in
            },
            errorHandler: { error in
            }
        ) { result in
            
        }
}

Для версий до контейнера

Чеклист миграции

• API обновлен до версии 6.4.1 или выше, есть поддержка session_token.

  • Content-Type изменен на application/octet-stream.

  • Для Instant API получены приватный и публичный ключи.

• Мобильные SDK обновлены до версии 8.22 или выше.

  • На бэкенде реализован запрос для получения session_token.

  • Используется новый публичный интерфейс: createMediaCaptureScreen с CaptureRequest.

• Web SDK обновлен до версии 1.9.2 или выше.

  • use_wasm_container установлен в true.

  • api_use_session_token установлен в api или client.

  • Если api_use_session_token = client, session_token запрашивается до начала сессии и передаётся в open.options().