README

此包提供与 Sicredi API 交互的 PHP 客户端。它允许开发者轻松地将 Sicredi 集成到他们的 PHP 应用程序中。客户端支持费用 API 中的广泛功能，包括创建和查询票券、生成票券收据以及检索付款报告。

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

虽然该包目前仅支持 Boletos API，但它设计时考虑了可扩展性，可以轻松扩展以支持所需的其他功能。

安装

首先，您需要按照他们网站上的说明安装Composer。

然后，只需运行以下命令

composer require BrunoPansani/sicredi-api

用法

安装后，您可以使用以下步骤创建一个新的票券

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

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

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

在客户端实例上调用 authenticate() 方法，通过传递您的 Sicredi API 用户名和密码作为参数来对 Sicredi API 进行认证。
通过调用 boleto() 方法从客户端实例获取票券资源客户端。例如

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

$boletoClient = $client->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')
);

在票券资源客户端上调用 create() 方法创建票券。例如

$boletoClient->create($boleto);

存储或执行您需要使用 create() 方法返回的票券信息所进行的任何其他操作。

验证和生产

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

总结来说，验证的过程包括以下步骤

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

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

在创建沙盒应用后，开发者应通过开发者门户中的 'Suporte' > 'Abrir Chamado' 菜单请求沙盒 API 令牌。选择合适的选项并填写之前创建的应用的名称。API 令牌将在几天内生成，可以在 'Minhas Apps' 菜单下找到，在相应应用的详细信息中。

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

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

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

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

贡献

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

从仓库分叉并做出您的更改。
提交一个带有对您的更改及其必要性的明确解释的拉取请求。
对反馈做出响应，并愿意对您的拉取请求进行更改。

请记住，您始终可以检查Sicredi的文档，这些文档位于docs/。

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

许可

此包在MIT许可下发布。

联系方式

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

r2soft / r2-sicredi-api

维护者

详细信息

README

安装

用法

验证和生产

贡献

许可

联系方式