Flutter金融连接插件teller_connect_flutter的使用

Flutter金融连接插件teller_connect_flutter的使用

A Flutter插件用于集成Teller Connect SDK，允许与金融机构无缝连接并访问金融数据。

目录

• 支持平台
• 安装
• 使用
  • 初始化
  • 功能
    • 启动Teller Connect
    • 事件流
      • 监听事件
      • 事件类型
    • 数据访问
  • 示例
  • 更多信息
  • 许可
  • 致谢

支持平台

• ✅ Android
• ⏳ iOS (即将推出)

安装

在您的Flutter项目的pubspec.yaml文件中添加以下依赖：

dependencies:
  ...
  teller_connect_flutter: ^0.9.4

使用

在您的库中添加以下导入：

import 'package:teller_connect_flutter/teller_connect_flutter.dart';

初始化

在main方法中调用initialize方法以初始化SDK。

void main() {
  TellerConnectFlutter.initialize();
  runApp(MyApp());
}

稍后在应用程序中，您可以调用TellerConnectFlutter.instance上的方法来与SDK交互。

功能

启动Teller Connect

要启动Teller Connect流程，请使用startTellerConnect方法：

TellerConnectFlutter.instance.startTellerConnect(
  appId: 'your_app_id',
  saveToken: (token) async {
    // 安全保存令牌
  },
  getToken: () async {
    // 获取已保存的令牌
  },
  ...
);

参数：

事件流

TellerConnectFlutter提供了一个事件流，您可以监听Teller Connect过程的更新。您可以使用TellerConnectFlutter.instance.onTellerEvent访问此流。

监听事件

TellerConnectFlutter.instance.onTellerEvent.listen((event) {
  // 处理不同的事件类型
  switch (event) {
    case InitEvent _:
      return print('TellerConnect initialized');
    case final RegisterSuccessEvent r:
      print(
        '''TellerConnect registered successfully:
        token: ${r.accessToken},
        userId: ${r.userId},
        institution: ${r.institutionName},
        enrollmentId: ${r.enrollmentId}''',
      );
    case final FailureEvent f:
      return print(
        '''TellerConnect failed:
        ${f.message},
        code: ${f.code},
        type: ${f.type}''',
      );
    case ExitEvent _:
      return print('TellerConnect exited');
    // ...处理其他事件类型
    default:
      return print('TellerConnect event: $event');
  }
});

事件类型

该流返回以下事件类型，所有这些都继承自TellerEventModel：

数据访问

注册成功后，您可以访问金融数据。SDK提供了获取连接账户和交易的方法。

注意：仅对于在Teller Connect注册过程中选择的账户，事务和详细信息才会被返回。

final teller = TellerConnectFlutter.instance;
// 获取连接账户
List<AccountModel> accounts = await teller.getConnectedAccounts(enrollmentId);

// 获取账户详细信息
AccountModel account = await teller.getAccount(accountId: accountId, enrollmentId: enrollmentId);

// 删除所有连接账户
bool isRemoved = await teller.removeAccounts(enrollmentId);

// 删除连接账户
bool isRemoved = await teller.removeAccount(accountId: accountId, enrollmentId: enrollmentId);

// 获取账户交易
List<TransactionModel> transactions = await teller.getAccountTransactions(
  accountId: accountId,
  enrollmentId: enrollmentId,
  count: 10,
  fromId: 'LAST_TRANSACTION_ID',
);
// 或 await teller.getAccountTransactions(accountId) 获取所有交易。建议首次调用时加载所有交易，然后使用`count`和`fromId`参数在未来加载更多交易。

// 获取交易详细信息
TransactionModel transaction = await teller.getTransaction(accountId, transactionId);

示例

import 'dart:async';
import 'dart:developer';

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:teller_connect_flutter/teller_connect_flutter.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 1. 初始化SDK
  TellerConnectFlutter.initialize(
    appId: 'app_ough6na3p9ve6id794000',
    certFile: (await rootBundle.load('assets/certificate.pem')).buffer.asUint8List(),
    keyFile: (await rootBundle.load('assets/private_key.pem')).buffer.asUint8List(),
  );

  runApp(
    const MyApp(),
  );
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late StreamSubscription<TellerEventModel> _subscription;
  final tokens = <String, String>{};

  [@override](/user/override)
  void initState() {
    super.initState();
    // 2. 监听Teller Connect事件
    _subscription = TellerConnectFlutter.instance.onTellerEvent.listen(_handleTellerEvent);
  }

  void _handleTellerEvent(TellerEventModel event) async {
    if (event is InitEvent) {
      log('Teller Connect initialized');
    } else if (event is RegisterSuccessEvent) {
      log('Registration successful: ${event.accessToken}');
      // 处理成功注册
      final accounts = await TellerConnectFlutter.instance.getConnectedAccounts(event.enrollmentId);
      log('Connected accounts: $accounts');

      final accountId = accounts.first.id;
      final accountDetails = await TellerConnectFlutter.instance.getAccount(
        accountId: accountId,
        enrollmentId: event.enrollmentId,
      );
      log('Account details: $accountDetails');

      final transactions = await TellerConnectFlutter.instance.getAccountTransactions(
        accountId: accountId,
        enrollmentId: event.enrollmentId,
      );
      log('Transactions: $transactions');

      final transactionId = transactions.first.id;
      final transactionDetails = await TellerConnectFlutter.instance.getTransaction(
        transactionId: transactionId,
        accountId: accountId,
        enrollmentId: event.enrollmentId,
      );
      log('Transaction details: $transactionDetails');
    } else if (event is FailureEvent) {
      log('Error: ${event.message}');
      // 处理失败
    }
  }

  Future<void> _startTellerConnect() {
    return TellerConnectFlutter.instance.startTellerConnect(
      saveToken: (token, enrollmentId) async {
        setState(() {
          tokens[enrollmentId] = token;
        });
      },
      getToken: (enrollmentId) => Future.value(
        tokens[enrollmentId]!,
      ),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Teller Connect Example'),
        ),
        body: Center(
          child: FutureBuilder<void>(
            future: _startTellerConnect(),
            builder: (context, snapshot) {
              if (snapshot.connectionState == ConnectionState.waiting) {
                return const CircularProgressIndicator();
              } else if (snapshot.hasError) {
                return Text('Error: ${snapshot.error}');
              }
              return ElevatedButton(
                onPressed: () {
                  setState(() {});
                }, // 3. 启动Teller Connect
                child: const Text('Start Teller Connect'),
              );
            },
          ),
        ),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    _subscription.cancel();
    super.dispose();
  }
}