Flutter身份验证插件veriff_flutter的使用

简介

Veriff Flutter 插件用于在 Flutter 应用中集成 Veriff 身份验证功能。本文档将介绍如何添加和配置该插件，并提供一个完整的示例 demo。

Requirements（要求）

集成 Veriff Flutter 插件需要项目至少支持 iOS 版本 13.0 和 Android 版本 8.0 (API 26) 或更高版本。

添加插件到项目

在 pubspec.yaml 文件中添加 Veriff Flutter 插件：

dependencies:
  veriff_flutter: ^latest_version

请确保替换 ^latest_version 为最新发布的版本号。

iOS 特定配置

添加使用描述到应用的 Info.plist

Veriff 需要相机、麦克风、照片库以及可选的 NFC 读取器权限来捕获照片、视频和扫描护照等操作。你需要在应用的 Info.plist 文件中添加以下描述，解释为什么需要这些权限：

• NSCameraUsageDescription
• NSMicrophoneUsageDescription
• NSPhotoLibraryUsageDescription

例如：

<key>NSCameraUsageDescription</key>
<string>We need access to your camera for identity verification.</string>
<key>NSMicrophoneUsageDescription</key>
<string>We need access to your microphone for identity verification.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>We need access to your photo library for identity verification.</string>

设置 iOS 目标版本

确保在 Xcode 中设置“iOS Deployment Target”为 iOS 13.0 或更高版本（位于 Project > target > Info > Deployment Target）。

开始验证流程

导入插件到代码

要在代码中使用 Veriff 插件，请导入它：

import 'package:veriff_flutter/veriff_flutter.dart';

启动验证流程

为了启动验证流程，请创建一个包含从后端实现接收的 sessionUrl 的配置对象：

Configuration config = Configuration(sessionUrl);

然后将配置传递给 Veriff 对象并启动验证流程：

Veriff veriff = Veriff();

try {
  Result result = await veriff.start(config);
  print(result.status);
  print(result.error);
} on PlatformException {
  // 处理异常
}

自定义用户界面（可选）

你可以通过定义品牌主色和 logo 来自定义 Veriff SDK 用户界面。可以通过传递可选参数来启动 Veriff 时进行自定义：

String regularFontPath = "fonts/Regular.otf";
String mediumFontPath = "fonts/Medium.otf";
String boldFontPath = "fonts/Bold.otf";
Fonts fonts = Fonts(
    regularFontPath: regularFontPath, 
    mediumFontPath: mediumFontPath, 
    boldFontPath: boldFontPath
);
Branding branding = Branding(
    logo: AssetImage('assets/images/logo.png'),
    background: "#f2ff00",
    onBackground: "#ff00ff",
    onBackgroundSecondary: "#52b35c",
    onBackgroundTertiary: "#3a593d",
    primary: "#123abc",
    onPrimary: "#ff00ff",
    secondary: "#f2ff00",
    onSecondary: "#ff7700",
    cameraOverlay: "#59496a",
    onCameraOverlay: "#e27e23",
    outline: "#ff00ff",
    error: "#ff0000",
    success: "#00ff00",
    buttonRadius: 5,
    fonts: fonts
);

Configuration config = Configuration(sessionUrl, branding: branding);

设置用户界面语言

可以设置 UI 的语言，例如：

Configuration config = Configuration(sessionUrl, branding: branding, languageLocale: "et");

完整示例 Demo

下面是一个完整的示例 demo，展示了如何集成 Veriff Flutter 插件：

import 'package:flutter/material.dart';
import 'package:veriff_flutter/veriff_flutter.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Veriff Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String sessionUrl = "https://your-backend-url/session";

  void startVerification() async {
    try {
      Configuration config = Configuration(sessionUrl);
      Veriff veriff = Veriff();
      Result result = await veriff.start(config);
      print("Status: ${result.status}");
      print("Error: ${result.error}");
    } catch (e) {
      print("Failed to start verification: $e");
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Veriff Flutter Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: startVerification,
          child: Text('Start Verification'),
        ),
      ),
    );
  }
}

以上就是关于 Flutter 身份验证插件 veriff_flutter 的使用指南。希望这个示例能帮助你顺利集成 Veriff 到你的 Flutter 应用中。