README

葡萄牙语 | 英文

PHP SDK，用于与Efi Pay API集成，包括Pix、账单、分期付款、信用卡、订阅、支付链接、市场平台、Open Finance的Pix、账单支付等功能。有关更多技术信息和价格/费用，请访问我们的网站。

转到

要求
已测试与
安装
开始
如何获取Client-Id和Client-Secret凭据
- 创建一个新的应用程序以使用Efi Pay API
如何生成Pix证书
如何注册Pix密钥
- 通过数字账户注册Pix密钥
- 通过API注册Pix密钥
执行示例
版本指南
兼容框架
附加文档
Discord社区
迁移验证器
- 如何使用验证器
许可证

要求

PHP >= 7.2.5
Guzzle >= 7.0
Symfony/Cache >= 5.0 || >= 6.0
启用openssl扩展

已测试与

PHP 7.2, 7.3, 7.4, 8.0, 8.1, 8.2, 8.3

安装

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

git clone https://github.com/efipay/sdk-php-apis-efi.git
composer install

或者，如果您已经使用Composer管理项目，请将依赖项添加到您的composer.json文件中

...
"require": {
  "efipay/sdk-php-apis-efi": "^1"
},
...

或者直接使用Composer下载此包

composer require efipay/sdk-php-apis-efi

开始

要开始，您必须在/examples/credentials/options.php文件中配置凭据。为认证实例化clientId和clientSecret信息，并将sandbox设置为true（如果您的环境为测试环境），或设置为false（如果为生产环境）。如果您使用Pix API、Open Finance API和账单支付API，请在certificate属性中指定包含文件名的绝对目录，格式为.p12或.pem。

查看配置示例

$options = [
	"clientId" => "Client_Id...",
	"clientSecret" => "Client_Secret...",
	"certificate" => realpath(__DIR__ . "/arquivoCertificado.p12"), // Caminho absoluto para o certificado no formato .p12 ou .pem
	"pwdCertificate" => "", // Opcional | Padrão = "" | Senha de criptografia do certificado
	"sandbox" => false, // Opcional | Padrão = false | Define o ambiente de desenvolvimento entre Produção e Homologação
	"debug" => false, // Opcional | Padrão = false | Ativa/desativa os logs de requisições do Guzzle
	"timeout" => 30, // Opcional | Padrão = 30 | Define o tempo máximo de resposta das requisições
	"responseHeaders" => false, //  Optional | Default = false || Ativa/desativa o retorno do header das requisições
];

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

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

use Efi\Exception\EfiException;
use Efi\EfiPay;

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

try {
	$api = new EfiPay($options);
	/* chamada da função desejada */
} catch(EfiException $e) {
	/* Os erros da API virão aqui */
	print_r($e->code . "<br>");
	print_r($e->error . "<br>");
	print_r($e->errorDescription . "<br>");
} catch(Exception $e) {
	/* Outros erros virão aqui */
	print_r($e->getMessage());
}

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

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

在Efí数字账户面板的菜单中访问API。
在侧边菜单中，单击应用然后单击创建应用。
输入应用程序名称，并选择要激活的API：API发行（账单和分期付款）和/或 Pix 和/或支付。在此情况下，Pix；这些可以在以后更改）。
选择要释放的生产和测试（开发）范围
单击创建应用。
输入您的电子签名以确认更改并更新应用程序。

如何生成Pix证书

Pix的所有请求都必须包含由Efí在其账户中提供的安全证书，格式为PFX（.p12）。这一要求在PIX安全手册中有详细说明。

要生成您的证书

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

如何注册Pix密钥

可以通过Efí手机应用、数字银行账户或API端点进行Pix密钥的注册。以下是如何注册它们的步骤。

通过数字账户注册Pix密钥

访问您的数字银行账户。
在侧边菜单中，点击 Pix。
点击 我的密钥，然后点击 注册密钥 按钮。
您必须选择至少1个可用的4种密钥选项（身份证/营业执照、电子邮件、手机或随机密钥）。
注册所需的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。

版本指南

兼容框架

SDK还可以与其他PHP框架集成。请确保满足 最低要求。

附加文档

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

如果您还没有Efí Bank的数字银行账户，现在就开设一个！

Discord社区

如果您需要将您的系统或应用程序集成到完整的支付API中，想要交换经验并分享您的知识，请连接到 Efí在Discord的社区。

迁移验证器

如果您已经使用Gerencianet的PHP SDK进行了集成，并正在为Efí的API未来的创新做准备，您可以使用我们的迁移验证器来帮助迁移到这个SDK。

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

在修改您的应用程序代码之前，强烈建议您备份整个项目。

如何使用验证器

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

验证器有助于识别潜在的迁移问题并提供修正建议，但必须记住每个应用都是独特的，可能存在无法自动处理的特定情况。完成建议的修正后，强烈建议对其应用进行广泛的测试，以验证SDK的正确运行。

许可证

MIT

efipay / sdk-php-apis-efi

维护者

详细信息