Flutter集成STK插件ilebora_stk的使用

Flutter集成STK插件ilebora_stk的使用

特性

• STK推送支付: 通过STK推送发起M-Pesa支付，提供用户友好的体验。

安装

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

dependencies:
  ilebora_stk: ^1.0.0

然后运行以下命令来获取依赖：

flutter pub get

使用

首先，导入插件：

import 'package:ilebora_stk/ilebora_stk.dart';

初始化并使用插件：

void main() {
  // 初始化BoraSTK
  final boraSTK = BoraSTK(
    userID: 'developer_user_id', // 提供的用户ID
    apiKey: 'developer_api_key', // 提供的API密钥
    phone: '254712345678', // 客户手机号码（Safaricom）
    amount: '100.00', // 支付金额
    orderID: 'unique_order_id', // 唯一订单ID
    displayName: 'Display Name', // 在STK推送中显示的名称
    onSuccess: (BoraPushTransaction response) {
      // 成功回调
      print('Payment Successful!');
      print(response);
    },
    onFailure: (String err) {
      // 失败回调
      print('Payment Failed!');
      print('Error: $err');
    },
  );

  // 显示STK屏幕
  // boraSTK.showSTKScreen(
  //   context,
  //   backgroundColor: Colors.white,
  //   buttonColor: Colors.green,
  //   textColor: Colors.white,
  // );

  // 显示STK对话框
  // boraSTK.showSTKDialog(
  //   context,
  //   backgroundColor: Colors.white,
  //   buttonColor: Colors.green,
  //   textColor: Colors.white,
  // );
}

API参考

BoraSTK 类

• 构造函数

  BoraSTK({
    required String userID,
    required String apiKey,
    required String phone,
    required String amount,
    required String orderID,
    required String displayName,
    required Function(BoraPushTransaction) onSuccess,
    required Function(String) onFailure,
  }): 初始化BoraSTK实例所需的参数。
  

• 方法

  generateToken(): 生成用于API请求的身份验证令牌。
  
  showSTKScreen(BuildContext context, {...}): 以新路由的形式显示STK推送屏幕。
  
  showSTKDialog(BuildContext context, {...}): 在AlertDialog中显示STK推送屏幕。
  

许可证

该项目采用MIT许可证 - 详情见LICENSE文件。

示例代码

以下是完整的示例代码：

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

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('STK Push Payment Example')),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              final BoraSTK boraSTK = BoraSTK(
                userID: 'developer_user_id', // 提供的用户ID
                apiKey: 'developer_api_key', // 提供的API密钥
                phone: '254712345678', // 客户手机号码（Safaricom）
                amount: '100.00', // 支付金额
                orderID: 'unique_order_id', // 唯一订单ID
                displayName: 'Display Name', // 在STK推送中显示的名称
                onSuccess: (BoraPushTransaction response) {
                  // 成功回调
                  print('Payment Successful!');
                  print(response);
                },
                onFailure: (String err) {
                  // 失败回调
                  print('Payment Failed!');
                  print('Error: $err');
                },
              );

              // 显示STK屏幕
              boraSTK.showSTKScreen(
                context,
                backgroundColor: Colors.white,
                buttonColor: Colors.green,
                textColor: Colors.white,
              );

              // 显示STK对话框
              // boraSTK.showSTKDialog(
              //   context,
              //   backgroundColor: Colors.white,
              //   buttonColor: Colors.green,
              //   textColor: Colors.white,
              // );
            },
            child: Text('Make Payment'),
          ),
        ),
      ),
    );
  }
}