Pix Sicoob – 易于使用的界面,用于将 Sicoob Pix API 集成到您的 Flutter 应用中。

Logo

此包提供了一个易于使用的界面,用于集成 Sicoob Pix API。使用此包,您可以快速有效地在您的 Flutter 应用中获取交易信息。

探索文档 »

报告错误 · 请求功能

License Pub Points Contributors Forks

Pub Publisher

目录
  1. 关于项目
  2. 使用方法
  3. 功能
  4. 贡献
  5. 许可证
  6. 联系方式
  7. 致谢

关于项目

Pix Sicoob PNG

此包提供了一个易于使用的界面,用于集成 Sicoob 的 Pix API。使用此包,您可以快速有效地在您的 Flutter 应用中获取交易信息。

先决条件

  • 已在 Sicoob 注册的密钥 Pix
  • 仅限法人实体
  • 由符合国际标准 x.509 的外部 CA 颁发的有效证书
  • Sicoob 开发者门户上注册

入门

要将此包安装到您的项目中,您可以按照以下说明进行操作

a) 添加到您的 pubspec.yaml

 dependencies:
    pix_sicoob: <last-version>

b) 或使用

 dart pub add pix_sicoob

使用方法

此包已准备好快速获取交易信息!

首先实例化类,传入适当的参数

获取Token

final pixSicoob = PixSicoob(
  clientID:'CLIENT_ID',
  certificateBase64String: 'X509_Parsed_TO_BASE64_STRING',
  /*
  This package offer a method to parses file certificate to base64 String
   Method:
    final certBase64String = pixSicoob.certFileToBase64String(
       pkcs12CertificateFile: File('test/cert/cert.pfx'),
       );
  */

  certificatePassword: 'CERTIFICATE_PASSWORD',
);

更多示例,请参阅 文档

功能

  • PIX
    • ✅ 获取收到的 PIX 交易
    • ? 获取特定的 pix 交易
    • ? 请求退款
    • ? 咨询退款

    )


    用例

    将证书文件转换为 Base64String

    final certBase64String = pixSicoob.certFileToBase64String(
       pkcs12CertificateFile: File('test/cert/cert.pfx'));

    请求令牌

    final token = await pixSicoob.getToken();

    获取 Pix 交易

    • 默认时间范围

    final listPix = await pixSicoob.fetchTransactions(
      token: token,
    );
    //Returns the last 4 days transactions
    • 自定义时间范围

    final listPix = await pixSicoob.fetchTransactions(
      token: token,
      dateTimeRange: DateTimeRange(
        start: DateTime.now().subtract(Duration(days: 360)),
        end: DateTime.now(),
      );
    );
    //Returns the transactions of the specified date range

    贡献

    ? 贡献指南 – 正在更新?

    贡献是开源社区成为学习、启发和创造的精彩场所的原因。您的任何贡献都不胜感激

    如果您有任何建议可以改进这一点,请 fork 该仓库并创建一个 pull request。您也可以简单地打开一个带有适当标签的问题。别忘了给项目点个星!再次感谢!

    1. Fork 该项目
    2. 创建您的特性分支(git checkout -b feature/AmazingFeature
    3. 提交您的更改(git commit -m 'Add some AmazingFeature'
    4. 推送到分支(git push origin feature/AmazingFeature
    5. 打开一个拉取请求

    上传提交和/或创建问题时,请记住包含标签,并遵循 约定式提交语义化版本

    许可证

    根据 MIT LICENSE.txt 分发,更多信息请参阅。

    架构

    查看项目中使用的架构 ARCHITECTURE.md

    致谢

    感谢所有为该项目做出贡献的人,没有你们,就没有今天的项目。

    维护者


    AcxTech Sistemas 构建和维护。

    GitHub

    查看 Github