Como instalar e usar o Oz Flutter Plugin

Encontre o repositório Flutter aqui.

Instalação e licenciamento

Adicione as linhas abaixo a pubspec.yaml do projeto ao qual você deseja adicionar o plugin.

Para 8.22 ou superior:

ozsdk: ^10.0.0

Para 8.21 e inferiores:

  ozsdk:
    git:
      url: https://gitlab.com/oz-forensics/oz-mobile-flutter-plugin.git
      ref: '8.8.2'

Adicione o arquivo de licença (por exemplo, license.json ou forensics.license) ao pasta assets do aplicativo Flutter . Em pubspec.yaml, especifique o asset do Flutter:

assets
  - assets/license.json // observe que o nome do arquivo de licença deve corresponder ao do arquivo colocado em assets

Para Android, adicione o repositório Oz a /android/build.gradle, seção allprojects → repositories:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url ‘https://ozforensics.jfrog.io/artifactory/main’ } // URL do repositório
    }
}

Para Flutter 8.24.0 ou superior ou Android Gradle plugin 8.0.0 ou superior, adicione em android/gradle.properties:

android.nonTransitiveRClass=false

A versão mínima do SDK deve ser 21 ou superior:

defaultConfig {
  ...
  minSDKVersion 21
  ...
}

Para iOS, defina a plataforma mínima como 13 ou superior em Runner → Info → Target de implantação → Target de implantação do iOS.

No ios/Podfile, comente a use_frameworks! linha (#use_frameworks!).

Primeiros passos com Flutter

Inicializando o SDK

Inicialize o SDK chamando o init método do plugin. Observe que o nome e o caminho do arquivo de licença devem corresponder aos especificados em pubspec.yaml (por exemplo, assets/license.json).

await OZSDK.initSDK([<% license path and license file name %>]);

Conectando o SDK à API

Use as credenciais da API (login, senha e URL da API) que você recebeu de nós.

await OZSDK.setApiConnectionWithCredentials(<login>, <password>, <host>);

Em produção, em vez de codificar o login e a senha dentro da aplicação, recomenda-se obter o token de acesso no seu backend por meio do método de autenticação da API e, em seguida, passá-lo para a sua aplicação:

 await OZSDK.setApiConnectionWithToken(token, host);

Por padrão, os logs são salvos junto com os dados das análises. Se for necessário manter os logs separados dos dados da análise, configure a conexão separada para telemetria conforme mostrado abaixo:

await OZSDK.setEventConnectionWithCredentials(<login>, <password>, <host>);

ou

await OZSDK.setEventConnectionWithToken(<token>, <host>);

Captura de vídeos

Para iniciar a gravação, use o startLiveness método para obter a mídia gravada:

await OZSDK.startLiveness(<actions>, <use_main_camera>);

Parâmetro	Tipo	Descrição
actions	List<VerificationAction>	Ações do vídeo capturado
use_main_camera	Boolean	Se True, usa a câmera principal; caso contrário, usa a frontal.

Observe: para as versões 8.11 e inferiores, o nome do método é executeLiveness, e ele retorna a mídia gravada.

Para obter o resultado da mídia, assine livenessResult conforme mostrado abaixo:

class Screen extends StatefulWidget {
  static const route = 'liveness';

  const Screen({super.key});

  @override
  State<Screen> createState() => _ScreenState();
}

class _ScreenState extends State<Screen> {
  late StreamSubscription<List<Media>> _subscription;

  @override
  void initState() {
    super.initState();

    // assine o resultado de Liveness
    _subscription = OZSDK.livenessResult.listen(
      (List<Media> medias) {
          // a mídia contém a mídia de Liveness
      },
      onError: (Object error) {
        // tratar o erro, na maioria dos casos PlatformException
      },
    );
  }

  @override
  Widget build(BuildContext context) {
    // omitido para encurtar o exemplo
  }

  void _startLiveness() async {
    // use startLiveness para iniciar a tela de Liveness
    OZSDK.startLiveness(<list of actions>);
  }

  @override
  void dispose() {
    // cancele a assinatura
    _subscription.cancel();
    super.dispose();
  }
}

Verificando Liveness e biometria facial

Para executar as análises, execute o código abaixo.

Crie o Análise objeto:

List<Analysis> analysis = [ Analysis(Type.quality, Mode.serverBased, <media>, {}), ];

Execute a análise formada:

final analysisResult = await OZSDK.analyze(analysis, [], {});

Se for necessário executar uma análise para uma pasta específica, passe o ID dela:

final analysisResult = await OZSDK.analyze(analysis, folderID, [], {});

O analysisResult a lista de objetos contém o resultado da análise.

Se for necessário usar mídia capturada por outro SDK, o código deve ser assim:

media = Media(FileTypedocumentPhoto, VerificationAction.oneShot, “photo_selfie”, null, <path to image>, null, null, “”)

O bloco de código completo ficará assim:

Liveness

// substitua VerificationAction.blank pelo gesto de Liveness, se necessário
final cameraMedia = await OZSDK.executeLiveness([VerificationAction.blank], use_main_camera);

final analysis = [
  Analysis(Type.quality, Mode.serverBased, cameraMedia, {}),
];

final analysisResult = await OZSDK.analyze(analysis, [], {});

Biometria

// substitua VerificationAction.blank pelo gesto de Liveness, se necessário
final cameraMedia = await OZSDK.executeLiveness([VerificationAction.blank], use_main_camera);
final biometryMedia = [...cameraMedia];
biometryMedia.add(
  Media(
    FileType.documentPhoto,
    VerificationAction.blank,
    MediaType.movement,
    null,
    <your reference image path>,
    null,
    null,
    MediaTag.photoSelfie,
  ),
);

final analysis = [
  Analysis(Type.quality, Mode.serverBased, cameraMedia, {}),
  Analysis(Type.biometry, Mode.serverBased, biometryMedia, {}),
];

final analysisResult = await OZSDK.analyze(analysis, [], {});