/gn-api-sdk-php

SDK em PHP integrada às APIs da Gerencianet preparada para emissão de cobranças Pix com QR Code e Pix Copia e Cola, split/divisão de Pix, boletos, carnês, cartão de crédito, assinatura, link de pagamento, marketplance, iniciação de pagamento Pix via Open Finance, pagamento de boletos, dentre outras funcionalidades.

Primary LanguagePHPMIT LicenseMIT

Aviso - SDK obsoleta

Gerencianet agora é Efí

A SDK de PHP da Gerencianet continua em funcionamento, porém não receberá mais atualizações. Recomendamos que migre para a nova SDK da Efí para continuar desfrutando de nossos serviços e novidades.

Para facilitar esse processo desenvolvemos o Validador de Migração, veja mais detalhes.

SDK Efí by Gerencianet para PHP

Português | Inglês

Última versão estável Licença Total de downloads Code Climate

SDK em PHP para integração com as APIs da Gerencianet 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 sobre parâmetros e valores/tarifas consulte nosso site.

Ir para:

Requisitos

  • PHP >= 7.2
  • Guzzle >= 7.0

Testado com

PHP 7.2, 7.3, 7.4, 8.0 e 8.1

Instalação

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

composer install

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

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

Ou baixe este pacote direto com Composer:

composer require gerencianet/gerencianet-sdk-php

Começando

Para começar, você deve configurar as credenciais no arquivo /examples/credentials/options.php. Instancie as informações client_id, client_secret para autenticação e sandbox igual a true, se seu ambiente for Homologação, ou false, se for Produção. Se você usa cobrança Pix, informe no atributo certificate o diretório absoluto e o nome do seu certificado no formato .p12 ou .pem.

Veja exemplos de configuração a seguir:

Para ambiente de homologação

Instancie os parâmetros do módulo usando client_id, client_secret, sandbox igual a true e certificate com o nome do certificado de homologação:

$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
];

Para ambiente de produção

Instancie os parâmetros do módulo usando client_id, client_secret, sandbox igual a false e certificate com o nome do certificado de produção:

$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
];

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

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

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

Embora as respostas dos serviços da web estejam no formato json, a SDK converterá qualquer resposta do servidor em array. O código deve estar dentro de um try-catch, e podem ser tratadas da seguinte forma:

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 */
}

Como obter as credenciais Client-Id e Client-Secret

Crie uma nova aplicação para usar a API Gerencianet:

  1. Acesse o painel da Gerencianet no menu API.
  2. No menu lateral, clique em Aplicações depois em Criar aplicação.
  3. Insira um nome para a aplicação, e selecione qual API quer ativar: API de emissões (boletos e carnês) e/ou API Pix e/ou Pagamentos. Neste caso, API Pix;que estes podem ser alterados posteriormente).
  4. selecione os Escopos de Produção e Escopos de Homologação (Desenvolvimento) que deseja liberar;
  5. Clique em Criar aplicação.
  6. Informe a sua Assinatura Eletrônica para confirmar as alterações e atualizar a aplicação.

Como gerar um certificado Pix

Todas as requisições do Pix devem conter um certificado de segurança que será fornecido pela Gerencianet dentro da sua conta, no formato PFX(.p12). Essa exigência está descrita na íntegra no manual de segurança do PIX.

Para gerar seu certificado:

  1. Acesse o painel da Gerencianet no menu API.
  2. No menu lateral, clique em Meus Certificados e escolha o ambiente em que deseja o certificado: Produção ou Homologação.
  3. Clique em Criar Certificado.
  4. Insira sua Assinatura Eletrônica para confirmar a alteração.

Como cadastrar as chaves Pix

O cadastro das chaves Pix pode ser feito através do aplicativo da Gerencianet ou por um endpoint da API. A seguir você encontra os passos de como registrá-las.

Cadastrar chave Pix pelo aplicativo mobile:

Caso ainda não tenha nosso aplicativo instalado, clique em Android ou iOS, de acordo com o sistema operacional do seu smartphone, para fazer o download.

Para registrar suas chaves Pix por meio do aplicativo:

  1. Acesse sua conta através do app Gerencianet.
  2. No menu lateral, toque em Pix para iniciar seu registro.
  3. Toque em Minhas Chaves e depois em Cadastrar Chave.
  4. Você deve escolher pelo menos 1 das 4 opções de chaves disponíveis (CPF/CNPJ, celular, e-mail ou chave aleatória).
  5. Após cadastrar as chaves do 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). Um detalhe é que, através deste endpoint é realizado o registro somente de chaves Pix do tipo aleatória.

Para consumí-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 body.

A resposta de exemplo abaixo representa Sucesso (201), apresentando a chave Pix registrada.

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

Executar exemplos

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

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

Guia de versão

Versão Status Packagist Repo Versão PHP
1.x Descontinuado /gerencianet/gerencianet-sdk-php#1.0.17 v1 >= 5.4
2.x Descontinuado /gerencianet/gerencianet-sdk-php#2.4.1 v2 >= 5.5
3.x Descontinuado /gerencianet/gerencianet-sdk-php#3.2.0 v3 >= 5.6
4.x Descontinuado /gerencianet/gerencianet-sdk-php#4.1.1 v4 >= 7.2
5.x Descontinuado /gerencianet/gerencianet-sdk-php v5 >= 7.2

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 da Gerencianet, abra a sua agora!

Validador de Migração

O Validador de Migração da SDK Efí Pay torna o processo de migração mais suave e eficiente. Essa ferramenta não modifica o seu código, somente 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 de 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