Download the PHP package efipay/sdk-php-apis-efi without Composer

On this page you can find all versions of the php package efipay/sdk-php-apis-efi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of efipay/sdk-php-apis-efi

Informations about the package sdk-php-apis-efi

SDK PHP para APIs Efí Bank

Banner APIs Efí Bank

Português | Inglês

Última versão estável Versão PHP necessária Total de downloads Downloads diários Code Climate Licença

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

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

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

Ou baixe este pacote direto com Composer:

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:

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

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:

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:

  1. Acesse o painel da conta digital do Efí no menu API.
  2. No menu lateral, clique em Aplicações e depois em Criar aplicação.
  3. 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.
  4. Selecione os escopos de Produção e Homologação que deseja liberar.
  5. Clique em Criar aplicação.
  6. 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:

  1. Acesse o painel da conta digital do Efí no menu API.
  2. No menu lateral, clique em Meus Certificados e escolha o ambiente desejado: Produção ou Homologação.
  3. Clique em Criar Certificado.
  4. 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:

  1. Acesse sua conta digital.
  2. No menu lateral, clique em Pix.
  3. Selecione Minhas Chaves e depois clique no botão Cadastrar Chave.
  4. Escolha pelo menos uma das 4 opções de chave disponíveis:
    • CPF/CNPJ
    • E-mail
    • Celular
    • Chave aleatória
  5. Após cadastrar as chaves Pix desejadas, clique em Continuar.
  6. 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:

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:

  1. Faça o download do Validador de Migração.
  2. Certifique-se de inserir este arquivo migrationChecker.php no diretório raiz do seu projeto.
  3. 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.
  4. Execute o Verificador de Migração, que analisará seus arquivos em busca de problemas.
  5. Revise os resultados apresentados, identificando os trechos de código que precisam ser atualizados.
  6. 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.

Validador de Migração

Licença

MIT

All versions of sdk-php-apis-efi with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2.5
guzzlehttp/guzzle Version ^7.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package efipay/sdk-php-apis-efi contains the following files

Loading the files please wait ....