Pular para o conteúdo principal

PHP

Saiba como instalar e configurar nossa SDK de PHP para API Pix e API Cobranças

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.


Atenção!

As requisições feitas às APIs da Efí, utilizando a sdk de PHP precisam do certificado gerado em sua conta Efí no formato .pem ou .p12.


Pré-requisitos​

Os seguintes pré-requisitos devem ser considerados, de acordo com a branch utilizada:

SDK Efí Pay​

Versão da branchStatusPackagistRepositório Versão do PHP
1.xMantidoefipay/sdk-php-apis-efimaster >= 7.2

Instalação via Packagist com o Composer​

  composer require efipay/sdk-php-apis-efi

Instalando versão mais recente via GitHub com o Git​

Nossa SDK também está disponível em nosso repositório no Github da Efí.

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

Após a instalação, o download das dependências irá acontecer automaticamente, estas serão armazenadas em suas respectivas pastas e o Composer continuará com o restante do trabalho ao gerar o arquivo composer.lock.

Cabe frisar que, caso você necessite, por exemplo, excluir um pacote, basta deletar sua referência do arquivo composer.json e atualizar o Composer através do seguinte comando:

$ composer update

Dessa forma, o Composer será atualizado e, como não há mais a presença do pacote na diretiva require, ele será imediatamente "desinstalado".


Resumo​

  • Instalar o Composer;
  • Informar, no arquivo composer.json, a SDK da Efí que será instalada;
  • Executar o comando de instalação no diretório do projeto: composer install;
  • Pronto!

Executar exemplos​

Você pode executar usando qualquer servidor web, como Apache ou nginx e abrir qualquer exemplo em seu navegador.

Informação

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


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.

Para saber mais detalhes de como utilizar, consulte nosso repositório do Github.


Erros Comuns (cURL error 60 ou cURL error 77)​

Os erros a seguir não são da API Efí, mas relacionados à componentes de seu servidor. Confira abaixo os erros mais comuns durante a instalação de nossa API e veja as soluções:


Extra: timeout option​

Este atributo está presente na SDK de PHP e permite que você defina no request do Guzzle em quanto tempo você quer que a resposta seja retornada. Para detalhes de como utilizar, consulte nosso repositório do Github.

Última atualização em