Flutter苹果支付集成插件tap_apple_pay_flutter的使用

ApplePay-Flutter

一个由Tap Payments提供的flutter插件，用于在您的Flutter应用中接受Apple Pay付款。

开始使用

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

dependencies:
  tap_apple_pay_flutter: 1.0.3

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

import 'package:tap_apple_pay_flutter/models/models.dart';

然后在flutter终端执行以下命令：

cd ios
pod install
pod update

最低要求

• Dart版本 3.0.0+
• Flutter版本 3.0.0+
• iOS版本 13.0+

SDK响应格式

在整个应用与Tap Apple Pay SDK的交互过程中，我们确保您会收到相同的响应格式，以简化您的解析过程。格式始终如下：

成功情况

{'success':true,'data':''}

• success为true时，表示流程已成功完成。
• data是一个可选对象，将传递任何作为操作结果的数据。

错误情况

{'success':false,'error':''}

• success为false时，表示流程失败。
• error是一个字符串，标识发生的错误。

预渲染设置

在呈现Apple Pay小部件之前，需要进行一些设置。这些配置将定义Apple Pay小部件所需的令牌化和样式数据。以下是一个配置Apple Pay小部件的代码示例：

Future<void> setupApplePay({
  // 测试密钥，注册您的Bundle ID时提供
  String sandboxKey = "pk_test_Vlk842......",
  // 生产密钥，注册您的Bundle ID时提供
  String productionKey = "pk_live_UYnihb.....",
  // SDK模式枚举，定义应用程序运行环境
  // 接受值：SdkMode.sandbox / SdkMode.production
  required SdkMode sdkMode,
}) async {
  // 在插件级别存储数据
  TapApplePayFlutter.setupApplePayConfiguration(
    sandboxKey: sandboxKey,
    productionKey: productionKey,
    sdkMode: sdkMode,
  );
  
  try {
    // 调用Apple Pay Flutter SDK提供的公共接口
    // 它是一个未来类型，响应将遵循上述描述的结构
    var result = await TapApplePayFlutter.setupApplePay;
    
    if (result["success"]) {
      debugPrint("Apple pay plugin is configured properly.");
    } else {
      debugPrint("Apple pay plugin configuration failed : ${result["error"]}");
    }
  } catch (ex) {
    debugPrint("Error >>>>>> $ex");
  }
}

然后，在渲染小部件之前从代码中调用它：

setupApplePay(
  sandboxKey: "",
  productionKey: "",
  sdkMode: widget.sdkMode,
);

添加Apple Pay小部件

在您的小部件层次结构中，您可以像使用原生提供的小部件一样添加我们的Apple Pay小部件。示例如下：

TapApplePayFlutter.buildApplePayButton(
  // 定义Apple Pay按钮类型。它是[Apple](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaybuttontype)提供的值之一
  applePayButtonType: ApplePayButtonType.appleLogoOnly,
  // 定义Apple Pay按钮样式
  applePayButtonStyle: ApplePayButtonStyle.black,
  onPress: () { // 当小部件被点击时触发
    getApplePayToken(); // 生成原始Apple Pay令牌的示例代码
    getTapTokenToken(); // 生成Tap令牌的示例代码，可以通过Tap APIs对客户进行收费
  },
)

生成Apple Pay令牌

您可以请求我们的插件从Apple Pay系统授权付款，并为您提供原始Apple Pay令牌以供进一步使用。确保您已经调用了上面指示的setup过程，然后再调用此接口。

生成Apple Pay令牌的示例代码如下：

/// 模拟如何请求我们的插件生成原始Apple Pay令牌的示例函数
Future<void> getApplePayToken() async {
  try {
    // 我们的接口是未来的类型
    var result = await TapApplePayFlutter.getApplePayToken(
      config: ApplePayConfig(
        transactionCurrency: TapCurrencyCode.SAR, // 3个ISO数字货币代码。我们创建了一个枚举列表来防止拼写错误
        allowedCardNetworks: [ // 定义允许的卡方案列表供客户支付
          AllowedCardNetworks.AMEX,
          AllowedCardNetworks.VISA,
          AllowedCardNetworks.MASTERCARD,
        ],
        applePayMerchantId: "merchant.tap.gosell", // 这是在Apple Pay开发者账户内创建并链接到Apple Pay证书的Apple Pay商户ID
        amount: 1.0, // 总金额
        merchantCapabilities: [ // 允许的卡资金来源
          MerchantCapabilities.ThreeDS,
          MerchantCapabilities.Debit,
          MerchantCapabilities.Credit,
        ],
      ),
    );

    if (result["success"]) {
      debugPrint("Result of Apple Pay Token >>>>>> $result");
    } else {
      debugPrint("Error of Apple Pay Token >>>>>> $result");
    }
  } catch (ex) {
    debugPrint("Error >>>>>> $ex");
  }
}

生成Tap Apple Pay令牌

您可以请求我们的插件从Apple Pay系统授权付款，并生成一个Tap令牌。通过该令牌，您可以使用我们的API对客户进行收费。确保您已经调用了上面指示的setup过程，然后再调用此接口。

生成Tap Apple Pay令牌的示例代码如下：

/// 模拟如何请求我们的插件生成Tap Apple Pay令牌的示例函数
Future<void> getTapTokenToken() async {
  try {
    // 我们的接口是未来的类型
    var result = await TapApplePayFlutter.getTapToken(
      config: ApplePayConfig(
        transactionCurrency: TapCurrencyCode.SAR, // 3个ISO数字货币代码。我们创建了一个枚举列表来防止拼写错误
        allowedCardNetworks: [ // 定义允许的卡方案列表供客户支付
          AllowedCardNetworks.AMEX,
          AllowedCardNetworks.VISA,
          AllowedCardNetworks.MASTERCARD,
        ],
        applePayMerchantId: "merchant.tap.gosell", // 这是在Apple Pay开发者账户内创建并链接到Apple Pay证书的Apple Pay商户ID
        amount: 1.0, // 总金额
        merchantCapabilities: [ // 允许的卡资金来源
          MerchantCapabilities.ThreeDS,
          MerchantCapabilities.Debit,
          MerchantCapabilities.Credit,
        ],
      ),
    );

    if (result["success"]) {
      debugPrint("Result of Tap Apple Pay Token >>>>>> $result");
    } else {
      debugPrint("Error of Tap Apple Pay Token >>>>>> $result");
    }
  } catch (ex) {
    debugPrint("Error >>>>>> $ex");
  }
}