Flutter数据收集插件dlocal_data_collector_flutter的使用

DLocal的数据收集SDK Flutter插件适用于Android和iOS。

此插件是原生SDK的封装，原生SDK可以在以下位置找到：

• iOS
• Android

更多关于每个平台SDK功能的信息可以在这两个仓库中找到。

安装

在pubspec.yaml文件中添加以下依赖项：

dependencies:
  dlocal_data_collector_flutter: ^版本号

然后运行以下命令来安装依赖：

flutter pub get

使用

应用启动时的设置

在应用启动时，添加以下代码：

final _dlocalDataCollectorFlutterPlugin = DlocalDataCollectorFlutter();

await _dlocalDataCollectorFlutterPlugin.setUp("apiKey", 0);

await _dlocalDataCollectorFlutterPlugin.startSession();

将apiKey替换为您的密钥。
将environment替换为0（沙盒环境）或1（生产环境）。

将会话与交易关联

当用户开始结账交易时，获取会话ID：

String sessionId = await _dlocalDataCollectorFlutterPlugin.getSessionId();

注意: 如果未调用setUp和startSession，则会话ID将为undefined。

在支付请求中提交此值到additional_risk_data.device.event_uuid参数中。如果会话不可用或发生错误，sessionId可能为undefined。

示例代码

以下是一个完整的示例代码，展示如何使用dlocal_data_collector_flutter插件。

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

import 'package:flutter/services.dart';
import 'package:dlocal_data_collector_flutter/dlocal_data_collector_flutter.dart';

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

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

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

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';
  final _dlocalDataCollectorFlutterPlugin = DlocalDataCollectorFlutter();

  [@override](/user/override)
  void initState() {
    super.initState();
    initPlatformState();
  }

  // 异步初始化平台状态
  Future<void> initPlatformState() async {
    String platformVersion;
    try {
      // 设置API密钥和环境
      await _dlocalDataCollectorFlutterPlugin.setUp(
          "9c0cfa84-bfa6-4de1-b8ed-9ee26104031c", 0);

      // 启动会话
      await _dlocalDataCollectorFlutterPlugin.startSession();

      // 获取会话ID
      platformVersion = await _dlocalDataCollectorFlutterPlugin.getSessionId() ??
          'Unknown session Id';
    } on PlatformException {
      platformVersion = 'Failed to get session id.';
    }

    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Running on: $_platformVersion\n'),
        ),
      ),
    );
  }
}