README

Gerencianet的PHP SDK仍在运行，但不会收到更多更新。我们建议您迁移到新的Efí SDK，以继续享受我们的服务和更新。

为了简化此过程，我们开发了迁移验证器，更多信息请查看。

Gerencianet的PHP Efí SDK

葡萄牙语 | English

PHP SDK用于与Gerencianet的API集成，用于发行Pix、支票、账单、信用卡、订阅、支付链接、市场平台、Open Finance的Pix、支票支付等功能。有关参数和价格/费用的更多信息，请访问我们的网站。

转到

需求
测试过
安装
开始
- 针对测试环境
- 针对生产环境
如何获取Client-Id和Client-Secret凭据
- 创建一个新的应用程序以使用Gerencianet API
如何生成Pix证书
如何注册Pix密钥
- 通过移动应用程序注册Pix密钥
- 通过API注册Pix密钥
运行示例
版本指南
附加文档
迁移验证器
- 如何使用验证器
许可证

需求

PHP >= 7.2
Guzzle >= 7.0

测试过

PHP 7.2, 7.3, 7.4, 8.0 e 8.1

安装

克隆此存储库并运行以下命令以安装依赖项

composer install

或者如果您已经使用Composer管理项目，请在您的composer.json文件中包含此依赖项

...
"require": {
  "gerencianet/gerencianet-sdk-php": "^5"
},
...

或者直接使用Composer下载此包

composer require gerencianet/gerencianet-sdk-php

开始

开始之前，您需要在/examples/credentials/options.php文件中配置凭据。为认证实例化client_id和client_secret，将sandbox设置为true（如果是测试环境），或设置为false（如果是生产环境）。如果您使用Pix收费，请在certificate属性中指定证书的绝对目录和.p12或.pem格式的证书名称。

以下是一些配置示例

针对测试环境

使用client_id、client_secret、sandbox设置为true和certificate设置为同测试环境证书的名称实例化模块参数

$options = [
	"client_id" => "Client_Id...",
	"client_secret" => "Client_Secret...",
	"certificate" => realpath(__DIR__ . "/homologacao.p12"), // Caminho absoluto para o certificado no formato .p12 ou .pem
	"sandbox" => true,
	"debug" => false,
	"timeout" => 30
];

针对生产环境

使用client_id、client_secret、sandbox设置为false和certificate设置为同生产环境证书的名称实例化模块参数

$options = [
	"client_id" => "Client_Id...",
	"client_secret" => "Client_Secret...",
	"certificate" => realpath(__DIR__ . "/producao.p12"), // Caminho absoluto para o certificado no formato .p12 ou .pem
	"sandbox" => false,
	"debug" => false,
	"timeout" => 30
];

为了启动SDK，需要模块和命名空间

require __DIR__ . '/vendor/autoload.php';

use Gerencianet\Exception\GerencianetException;
use Gerencianet\Gerencianet;

尽管Web服务的响应格式为json，但SDK会将任何服务器响应转换为数组。代码应在try-catch块中，并可以按以下方式处理

try {
  /* chamada da função desejada */
} catch(GerencianetException $e) {
  /* Os erros da API do Gerencianet virão aqui */
} catch(Exception $e) {
  /* Outros erros virão aqui */
}

如何获取Client-Id和Client-Secret凭据

创建一个新的应用程序以使用Gerencianet API

在菜单中访问Gerencianet的API面板。
没有侧边菜单，点击应用，然后点击 创建应用。
为应用输入一个名称，并选择要激活的API：API发票（发票和收据）和/或 API Pix 和/或付款。在本例中，API Pix；这些可以在以后更改）。
选择要释放的生产范围和测试范围（开发）。
点击 创建应用。
提供您的电子签名以确认更改并更新应用。

如何生成Pix证书

所有Pix请求都必须包含一个由Gerencianet在您的账户内提供的格式为PFX(.p12)的安全证书。这项要求在PIX安全手册中有完整描述。

要生成您的证书

在菜单中访问Gerencianet的API面板。
在侧边菜单中，点击 我的证书 并选择您希望获得证书的环境：生产或测试。
点击 创建证书。
插入您的电子签名以确认更改。

如何注册Pix密钥

可以通过Gerencianet应用或API端点注册Pix密钥。下面是注册步骤。

通过移动应用程序注册Pix密钥

如果您还没有安装我们的应用，请根据您的智能手机操作系统点击以下链接下载：Android 或 iOS。

通过应用注册您的Pix密钥

通过 Gerencianet应用 登录您的账户。
在侧边菜单中，点击 Pix 以开始注册。
点击 我的密钥，然后点击 注册密钥。
您必须至少选择以下4种密钥选项之一（CPF/CNPJ、手机、电子邮件或随机密钥）。
注册所需的Pix密钥后，点击继续。
插入您的电子签名以确认注册。

通过API注册Pix密钥

用于创建随机Pix密钥（evp）的端点是 POST /v2/gn/evp（《创建evp密钥》）。一个细节是，通过此端点仅注册随机类型的Pix密钥。

要使用它，只需执行我们的SDK的 /examples/exclusive/key/pixCreateEvp.php 示例即可。发送到此端点的请求不需要body。

下面的示例响应表示成功（201），显示已注册的Pix密钥。

{
  "chave": "345e4568-e89b-12d3-a456-006655440001"
}

运行示例

您可以使用任何Web服务器（如Apache或nginx）和在任何浏览器中打开任何示例来执行。

⚠️ 一些示例需要您更改一些参数才能运行，例如 /examples/charges/billet/createOneStepBillet.php 或 /examples/pix/cob/pixCreateCharge.php。

版本指南

附加文档

包含所有端点和API详细信息的完整文档可在 https://dev.efipay.com.br/ 上找到。

如果您还没有Gerencianet的数字账户，现在就开通吧！

迁移验证器

Efí Pay SDK的迁移验证器使迁移过程更加顺畅和高效。此工具不会修改您的代码，只会分析现有代码中与SDK新版本中修改过的类和方法相关的特定模式。

在进行任何代码修改之前，强烈建议您备份整个项目。

如何使用验证器

下载迁移验证器。
请确保将此文件 migrationChecker.php 插入到项目根目录中。
修改 migrationChecker.php 文件，并确保在 第 55 行 和 第 56 行 正确插入 composer.json 和 installed.json 文件的路径。
执行 迁移检查器，它会分析您的文件并查找问题。
检查显示的结果，识别需要更新的代码片段。
根据显示的说明进行推荐修复。

检查器有助于识别潜在的迁移问题并提供修复建议，但必须记住每个应用都是独特的，可能存在无法自动处理的特殊情况。在进行建议的修复后，强烈建议对您的应用进行彻底测试，以验证 SDK 的正常工作。

许可证

MIT

gerencianet / gerencianet-sdk-php

维护者

详细信息