README

Português | Inglês

SDK em PHP para integração com as APIs Efí para emissão de Pix, boletos, carnês, cartão de crédito, assinatura, link de pagamento, marketplance, Pix via Open Finance, pagamento de boletos, dentre outras funcionalidades. Para mais informações técnicas e valores/tarifas, consulte nosso site.

Ir para:

Requisitos
Testado com
Guia de versão
Instalação
Começando
Executar exemplos
Como obter as credenciais Client-Id e Client-Secret
- Crie uma nova aplicação para usar as APIs Efí Pay:
Como gerar um certificado Pix
Como cadastrar as chaves Pix
- Cadastrar chave Pix pela conta digital web:
- Cadastrar chave Pix através da API:
Frameworks compatíveis
Documentação Adicional
Comunidade no Discord
Validador de Migração
- Como usar o Validador:
Licença

Requisitos

PHP >= 7.2.5
Guzzle >= 7.0
Extensão openssl habilitada no PHP

Testado com

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

Guia de versão

Versão	Status	Packagist	Repo	Versão PHP
1.x	Mantido	/efipay/sdk-php-apis-efi	v1	>= 7.2.5

Instalação

Clone este repositório e execute o comando para instalar as dependências

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

Ou se você já tem um projeto gerenciado com Composer, inclua a dependência em seu arquivo composer.json:

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

Ou baixe este pacote direto com Composer:

composer require efipay/sdk-php-apis-efi

Começando

Para começar, você deve configurar as credenciais no arquivo /examples/credentials/options.php. Instancie as informações clientId, clientSecret para autenticação e sandbox igual a true, se seu ambiente for Homologação, ou false, se for Produção. Com exceção da API Cobranças (Boleto/Carnê/Cartão de crédito), é obrigatório informar no atributo certificate o caminho absoluto com o nome do arquivo no formato .p12 ou .pem. Na sessão abaixo, você pode acompanhar como obter as credenciais e certificado.

Veja um exemplo de configuração das credenciais na SDK:

$options = [
	"clientId" => "Client_Id...",
	"clientSecret" => "Client_Secret...",
	"certificate" => realpath(__DIR__ . "/arquivoCertificado.p12"), // Obrigatório, com exceção da API Cobranças  | 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
];

Para iniciar a SDK, requer o módulo e os namespaces:

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

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

Embora as respostas dos serviços das APIs estejam no formato JSON, a SDK converterá a resposta da API em array. O código deve estar dentro de um try-catch, e deve ser tratado da seguinte forma:

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());
}

Executar exemplos

Você pode executar usando qualquer servidor web, como Apache ou nginx, e abrir qualquer exemplo em seu navegador ou linha de comando. Veja todos os exemplo aqui.

⚠️ Alguns exemplos requerem que você altere alguns parâmetros para funcionar, como /examples/charges/billet/createOneStepBillet.php ou /examples/pix/cob/pixCreateCharge.php.

Como obter as credenciais Client-Id e Client-Secret

Crie uma nova aplicação para usar as APIs do Efí Bank:

Acesse o painel da conta digital do Efí no menu API.
No menu lateral, clique em Aplicações e depois em Criar aplicação.
Insira um nome para a aplicação e selecione quais APIs deseja ativar:
- API Cobranças (boletos, carnês, cartão de crédito, link de pagamento, assinaturas);
- API Pix;
- API Pix via Open Finance;
- API Pagamento de contas;
- API Extratos.
Selecione os escopos de Produção e Homologação que deseja liberar.
Clique em Criar aplicação.
Insira sua Assinatura Eletrônica para confirmar a criação da aplicação.

Como gerar um certificado de autenticação das APIs

Todas as requisições às APIs, com exceção da API Cobranças, devem conter um certificado de segurança fornecido pelo Efí dentro da sua conta, no formato PFX (.p12).

Para gerar seu certificado:

Acesse o painel da conta digital do Efí no menu API.
No menu lateral, clique em Meus Certificados e escolha o ambiente desejado: Produção ou Homologação.
Clique em Criar Certificado.
Insira sua Assinatura Eletrônica ou autentique com o QR Code para confirmar a criação.

Como cadastrar as chaves Pix

O cadastro das chaves Pix pode ser feito pelo aplicativo mobile do Efí, pela conta digital web ou por um endpoint da API. A seguir, veja os passos para registrá-las.

Cadastrar chave Pix pela conta digital web:

Acesse sua conta digital.
No menu lateral, clique em Pix.
Selecione Minhas Chaves e depois clique no botão Cadastrar Chave.
Escolha pelo menos uma das 4 opções de chave disponíveis:
- CPF/CNPJ
- E-mail
- Celular
- Chave aleatória
Após cadastrar as chaves Pix desejadas, clique em Continuar.
Insira sua Assinatura Eletrônica para confirmar o cadastro.

Cadastrar chave Pix através da API:

O endpoint utilizado para criar uma chave Pix aleatória (EVP) é o POST /v2/gn/evp (Criar chave EVP). Vale lembrar que, por meio deste endpoint, é possível registrar apenas chaves Pix do tipo aleatória.

Para consumi-lo, basta executar o exemplo /examples/exclusive/key/pixCreateEvp.php da nossa SDK. A requisição enviada para esse endpoint não precisa de um corpo (body).

A resposta abaixo representa um exemplo de sucesso (201), com a chave Pix registrada:

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

Frameworks compatíveis

Framework	Versão Mínima Compatível	Observações
Laravel	7.x e superior	PHP >= 7.2.5, Guzzle 7.0, Symfony/Cache >= 5.0
CodeIgniter	4.x e superior	PHP >= 7.2.5 (Guzzle e Symfony/Cache, se usado)
Symfony	5.0 e superior	PHP >= 7.2.5, Guzzle 7.0, Symfony/Cache >= 5.0

A SDK pode ser integrada também com outros frameworks PHP. Certifique-se de atender aos requisitos mínimos.

Documentação Adicional

A documentação completa com todos os endpoints e detalhes das APIs está disponível em https://dev.efipay.com.br/.

Se você ainda não tem uma conta digital Efí Bank, abra a sua agora!

Comunidade no Discord

Se você tem a necessidade de integrar seu sistema ou aplicação a uma API completa de pagamentos, desejos de trocar experiências e compartilhar seu conhecimento, conecte-se à comunidade da Efí no Discord.

Validador de Migração

Se você já possui integração com a SDK de PHP da Gerencianet e está buscando preparar a sua aplicação para as inovações futuras das APIs Efí, você pode usar o nosso validador para auxiliar na migração para esta SDK.

O Validador de Migração da SDK Efí torna o processo de migração mais suave e eficiente. Essa ferramenta não modifica o seu código, apenas analisa o código existente em busca de padrões específicos relacionados a classes e métodos que foram modificados na nova versão da SDK.

Antes de realizar qualquer modificação no código da sua aplicação, é altamente aconselhável fazer um backup completo de todo o seu projeto.

Como usar o Validador:

Faça o download do Validador de Migração.
Certifique-se de inserir este arquivo migrationChecker.php no diretório raiz do seu projeto.
Altere o arquivo migrationChecker.php e certifique-se de inserir corretamente na linha 55 e 56 o caminho para os arquivos composer.json e installed.json.
Execute o Verificador de Migração, que analisará seus arquivos em busca de problemas.
Revise os resultados apresentados, identificando os trechos de código que precisam ser atualizados.
Realize as correções recomendadas, seguindo as instruções exibidas.

O verificador ajuda a identificar potenciais problemas de migração e oferece sugestões de correção, mas é essencial lembrar que cada aplicação é única e pode ter peculiaridades que não podem ser abordadas automaticamente. Após realizar as correções sugeridas, é altamente recomendado realizar testes extensivos em sua aplicação para validar o funcionamento adequado da SDK.

Licença

MIT

efipay / sdk-php-apis-efi

Maintainers

Details