Flutter保险卡扫描插件insurance_card_scanner的使用

我们的CardScanner Flutter小部件使得在任何Flutter应用程序中添加保险卡扫描功能变得非常简单，只需5分钟或更短的时间即可完成。

兼容性

安装

将insurance_card_scanner包添加到您的pubspec.yaml文件中。

dependencies:
  flutter:
    sdk: flutter
  insurance_card_scanner: ^1.1.0

或者，运行以下命令：

flutter pub add insurance_card_scanner

使用

在项目文件中导入库小部件：

import 'package:insurance_card_scanner/insurance_card_scanner.dart';

您可以选择性地添加API客户端以进行更多定制应用：

import 'package:insurance_card_scanner/insurance_card_scanner_api.dart';

此包依赖于CardScan AI进行保险卡的扫描和数据捕获。有关包设置和使用的完整理解，您可以参考包文档。

对于配置保险卡扫描器的步骤列表，请参阅示例应用README。

开始使用

Android相机权限

在您的AndroidManifest.xml文件中添加以下行：

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.VIDEO_CAPTURE" />

iOS相机权限

在您的Info.plist文件中添加以下行：

<key>NSCameraUsageDescription</key>
<string>您的描述，说明为什么需要访问相机</string>
<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoadsInWebContent</key>
    <true/>
    <key>NSAllowsLocalNetworking</key>
    <true/>
</dict>

沙箱API密钥

在仪表板上创建一个免费账户以生成沙箱API密钥。

基本示例

CardScanner小部件

可以在自定义屏幕上像其他小部件一样使用它：

import 'package:insurance_card_scanner/insurance_card_scanner.dart';

class ScannerWidgetScreen extends StatelessWidget {
  const ScannerWidgetScreen({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Scanner widget'),
      ),
      body: CardScanner(
        properties: CardScanConfig(
          sessionToken: '<pass your token here>',
          onSuccess: (card) {
            print('Scan success');
          },
          onError: (message) {
            print(message ?? 'Unknown Scan error');
          },
          onCancel: () {
            Navigator.of(context).pop();
          },
        ),
      ),
    );
  }
}

CardScannerModal小部件

通过Navigator推送以打开全屏扫描器：

Navigator.of(context).push(
  CardScannerModal(
    properties: CardScanConfig(
      sessionToken: 'pass your token here',
      onSuccess: (card) {
        print('Scan success');
      },
      onError: (message) {
        print(message ?? 'Scan error');
      },
      onCancel: () {
        Navigator.of(context).pop();
      },
    ),
  ),
);

可用属性

CardScanner 和 CardScannerModal 需要传递一个 CardScanConfig 实例，包含服务器连接、回调处理和UI定制的属性。

CardScanConfig(
  // 必需
  sessionToken: token,
  onSuccess: onSuccess,

  // 推荐
  onCancel: onCancel,
  onError: onError,
  live: live,

  // 可选
  backsideSupport: scanBackside,
  onRetry: onRetry,
  onWebViewLoadError: onWebViewLoadError,

  // UI 自定义
  messages: messages,
  messageStyle: messagesStyle,
  autoSwitchActiveColor: autoSwitchActiveColor,
  autoSwitchInactiveColor: autoSwitchInactiveColor,
  progressBarColor: progressBarColor,
  widgetBackgroundColor: widgetBackgroundColor,
)

认证

CardScan支持两种不同用途的认证：

• 服务器到服务器 - 后端系统、管理门户等。
• 最终用户 - 最可能是移动设备或网页上的患者或临床医生。

有关认证和生成JSON Web Token (JWT) 的详细信息，请查看认证文档。

官方文档

对于包设置和使用的完整理解，您可以参考包文档。

示例代码

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

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  runApp(const MyApp());
}

// 设置有效的会话令牌
const token = String.fromEnvironment("CS_API_KEY", defaultValue: "");

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Card Scanner Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MainScreen(),
    );
  }
}

class MainScreen extends StatelessWidget {
  const MainScreen({super.key});

  void showWidget(BuildContext context) => Navigator.of(context).push(
        MaterialPageRoute(
          builder: (ctx) => const ScannerWidgetScreen(),
        ),
      );

  void showModal(BuildContext context) => Navigator.of(context).push(
        CardScannerModal(
          properties: CardScanConfig(
            logging: CardScanLogLevel.verbose,
            sessionToken: token,
            live: false,
            onSuccess: (card) {
              debugPrint("Scanned card: $card");
              showMessage(context, 'Scan success');
            },
            onError: (message) {
              showMessage(context, message.toString() ?? 'Scan failed');
            },
            onWebViewLoadError: () {
              showMessage(context, 'WebView failed to load');
            },
            onCancel: Navigator.of(context).pop,
            autoSwitchActiveColor: Colors.purple,
            progressBarColor: Colors.purple,
            widgetBackgroundColor: Colors.purple,
            backsideSupport: true,
            messageStyle: const TextStyle(
              fontSize: 70,
              color: Color.fromARGB(255, 62, 176, 39),
              backgroundColor: Colors.white,
            ),
            messages: const CardScanMessages(
              autoCaptureTitle: 'autoCaptureTitle',
              cameraErrorTitle: 'cameraErrorTitle',
              completedTitle: 'completedTitle',
              errorTitle: 'errorTitle',
              frontSideCompletedTitle: 'frontsideCompletedTitle',
              manualCaptureTitle: 'manualCaptureTitle',
              processingTitle: 'processingTitle',
              retryTitle: 'retryTitle',
            ),
          ),
        ),
      );

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Card Scanner Example'),
      ),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.max,
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.center,
          children: [
            MaterialButton(
              onPressed: () => showWidget(context),
              color: Colors.blue,
              textColor: Colors.white,
              child: const Text('Show widget'),
            ),
            const SizedBox(height: 40),
            MaterialButton(
              onPressed: () => showModal(context),
              color: Colors.green,
              textColor: Colors.white,
              child: const Text('Show modal'),
            )
          ],
        ),
      ),
    );
  }
}

class ScannerWidgetScreen extends StatelessWidget {
  const ScannerWidgetScreen({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Scanner widget'),
      ),
      body: CardScanner(
        properties: CardScanConfig(
          logging: CardScanLogLevel.off,
          eligibility: const EligibilityRequest(
              provider: Provider(
                  firstName: "TestProviderFirstName",
                  lastName: "TestProviderLastName",
                  npi: "123456789"), // 对于有效的NPI，需要在9后面加3
              subscriber: Subscriber(
                  firstName: "Walter",
                  lastName: "Witman",
                  dateOfBirth: "19020403")),
          onEligibilitySuccess: (eligibility) {
            showMessage(context, 'Eligibility success');
            debugPrint("Eligibility sucess: $eligibility");
          },
          onEligibilityError: (error) {
            showMessage(context, 'Eligibility error');
            debugPrint("Eligibility error: $error");
          },
          sessionToken: token,
          live: false,
          onSuccess: (card) {
            debugPrint("Scanned card: $card");
          },
          onError: (error) {
            showMessage(context, error?.message ?? 'Scan failed');
            debugPrint("Error: $error");
          },
          onWebViewLoadError: () {
            showMessage(context, 'WebView failed to load');
          },
          onCancel: Navigator.of(context).pop,
          autoSwitchActiveColor: Colors.blue,
          progressBarColor: Colors.blue,
          widgetBackgroundColor: Colors.purple,
          autoSwitchInactiveColor: Colors.blue,
          backsideSupport: false,
          messageStyle: const TextStyle(
            fontSize: 70,
            color: Colors.blue,
            backgroundColor: Colors.white,
          ),
          messages: const CardScanMessages(
            autoCaptureTitle: 'autoCaptureTitle',
            cameraErrorTitle: 'cameraErrorTitle',
            completedTitle: 'completedTitle',
            errorTitle: 'errorTitle',
            frontSideCompletedTitle: 'frontsideCompletedTitle',
            manualCaptureTitle: 'manualCaptureTitle',
            processingTitle: 'processingTitle',
            retryTitle: 'retryTitle',
          ),
        ),
      ),
    );
  }
}

void showMessage(BuildContext context, String message) {
  showDialog(
    context: context,
    builder: (ctx) => AlertDialog(
      title: Text(message),
      actions: [
        TextButton(
          onPressed: Navigator.of(context).pop,
          child: const Text("OK"),
        )
      ],
    ),
  );
}