README

此软件包提供了与 Sicredi API 交互的 PHP 客户端。它允许开发者轻松地将 Sicredi 集成到他们的 PHP 应用程序中。客户端支持费用 API 中的各种功能，包括创建和查询 boletos、生成 boleto 票据和获取支付报告。

该软件包基于 Guzzle HTTP 客户端构建，并提供了一个简单、面向对象的 API 来与 Sicredi API 交互。它还包括全面的文档和示例，帮助开发者快速入门。

尽管该软件包目前仅支持 Boletos API，但它是可扩展的，可以轻松扩展以支持所需的其他功能。

安装

首先，您需要根据其网站上的说明安装 Composer。

然后，只需运行以下命令

composer require BrunoPansani/sicredi-api

用法

安装后，您可以使用以下步骤创建新的 Boleto

1. 创建一个新的客户端实例：通过将您的 Sicredi API 密钥、合作社会号码、邮政号码和受益人号码作为参数传递来创建一个新的客户端实例。例如

$client = new \SicrediAPI\Client(
    $_ENV['SICREDI_API_KEY'],
    $_ENV['SICREDI_COOPERATIVE'],
    $_ENV['SICREDI_POST'],
    $_ENV['SICREDI_BENEFICIARY'],
    new \GuzzleHttp\Client(), true);

此示例使用环境变量，但您可以使用任何您喜欢的方法传递参数。

1. 在客户端实例上调用 authenticate() 方法，通过传递您的 Sicredi API 用户名和密码作为参数来与 Sicredi API 进行身份验证。

2. 从客户端实例中获取 Boleto 资源客户端，通过调用 boleto() 方法。例如

$client->authenticate($_ENV['SICREDI_USERNAME'], $_ENV['SICREDI_PASSWORD']);

$boletoClient = $client->boleto();

1. 通过传递必要的参数创建新的 Boleto 实例，例如受益人信息、收款人信息、金额和到期日。例如

$boleto = new \SicrediAPI\Domain\Boleto\Boleto(
    (new Beneficiary(
        'Jose da Silva',
        '86049253099',
        'person'
    )),
    (new Payee(
        'Maria de Lurdes',
        '50581718054',
        'person'
    )),
    100.00,
    'DM',
    12345,
    'RECIBO',
    '999999',
    new DateTime('2023-12-31')
);

1. 在 Boleto 资源客户端上调用 create() 方法来创建 Boleto。例如

$boletoClient->create($boleto);

1. 存储和/或对 create() 方法返回的 Boleto 信息进行任何其他您需要执行的操作。

验证和生产

在从 Sicredi 使用 Cobrança API 之前，请按照附带的手册中的验证和生产步骤进行，手册可在 docs/ 中找到。

总之，验证过程包括以下步骤

1. 访问开发者门户
2. 为沙盒创建应用
3. 请求沙盒 API 令牌
4. 测试 Homologation 环境中可用的 URL
5. 为生产创建应用
6. 请求生产 API 令牌
7. 测试生产环境中可用的 URL
8. 部署您的解决方案

要创建沙盒应用，开发者必须访问 Sicredi 开发者门户，创建帐户或登录，并使用前缀 "API Cobrança Sandbox" 创建新的应用程序。

创建沙盒应用后，开发者应通过开发者门户中的“支持”>“打开工单”菜单请求沙盒 API 令牌。选择适当的选项并填写先前创建的应用名称。API 令牌将在几天内生成，可以在“我的应用”菜单下找到，在相应应用的详细信息中。

可用于测试的 URL 可在 API 手册中找到。

对于生产流程，重复创建APP的相同步骤，但使用不同的名称，例如“API Cobrança Production”。创建APP后，按照与沙盒相同的步骤请求生产API令牌。

请记住，在所有操作中，收到的身份验证令牌必须通知在请求的x-api-key头中。这个令牌在每个环境中都不同。

如果您有任何疑问，请参阅附件手册中列出的支持渠道，或访问开发者门户。

贡献

我们欢迎对这个包的贡献！如果您想做出贡献，请遵循以下指南

1. 对存储库进行分支并做出您的更改。
2. 提交一个带有您更改的明确解释和为什么它们是必要的pull请求。
3. 对反馈做出响应，并开放接受对您的pull请求进行更改。

请记住，您始终可以检查Sicredi的文档，这些文档可在docs/目录中找到。

感谢您对这个包做出贡献的兴趣！

许可证

此包在MIT许可证下发布。

联系方式

如果您有任何问题或问题，请通过bruno@pansani.dev与我联系。