Instalando versão mais recente da SDK PHP da Gerencianet via GitHub com o Git - Maykon Silveira

Como instalar a SDK PHP da Gerencianet - MaykonSilveira



Saiba como instalar e configurar nossa SDK em PHP para API Pix e API Boletos (Bolix)


Nossa API é RESTful e responde em JSON. A Gerencianet utiliza OAuth para fornecer acesso autorizado à API. Nossa SDK de PHP já está preparada para realizar essa autenticação automaticamente.

A seguir, confira os procedimentos para instalação da SDK da Gerencianet em PHP:

 

Instalando via Packagist com o Composer

composer require gerencianet/gerencianet-sdk-php

Instalando versão mais recente via GitHub com o Git

Link do git https://github.com/gerencianet/gn-api-sdk-php

git clone https://github.com/gerencianet/gn-api-sdk-php.git
cd gn-api-sdk-php/
composer install

É importante frisar que as extensões cURLjsonext-simplexml & openssl devem estar ativadas.

 

 IMPORTANTE

Atualmente, disponibilizamos quatro versões da SDK. A versão 1.x e 2.x é compatível com versões do PHP superiores à versão 5.4 e inferiores à 7.0, possuindo também alguns componentes desatualizados, como o Guzzle. Caso você tenha uma versão do PHP superior à 5.5 e inferior a 7.0, sugerimos utilizar a versão 3.x da nossa SDK. Para versões do PHP maior ou igual 7.2, sugerimos que instale a versão 4.x da SDK.

Vá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa:

  1. Pré-requisitos

  2. Instalação do Composer em Windows

  3. Instalação do Composer em Linux

  4. Instalação biblioteca PHP da Gerencianet sem o Composer

  5. Erros Comuns (cURL error 60 ou cURL error 77)

  6. Vídeo: Instalação do Composer (Windows e Linux)

  7. Extra: timeout option

1. Pré-requisitos

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

Versão da branch Status Packagist Repositório Versão do PHP

1.x

Mantido

gerencianet/gerencianet-sdk-php:1.0.17

v1

> = 5.4 (não é compatível com PHP 7.x)

2.x

Mantido

gerencianet/gerencianet-sdk-php:2.4.1

v2

> = 5.5 (compatível com PHP 7.x)

3.x

Mantido

gerencianet/gerencianet-sdk-php:3.1.0

v3

> = 5.6 (compatível com PHP 7.x e Guzzle <= 6.5.2)

4.x

Mantido

gerencianet/gerencianet-sdk-php

v4

> = 7.2

 Nota:

Para a utilização da biblioteca em PHP, recomendamos a instalação através do Composer (gerenciador de dependências).

Caso prefira prosseguir sem o Composer, basta seguir os procedimentos descritos no título 4. Instalação biblioteca PHP da Gerencianet sem o Composer.

 

2. Instalação do Composer em Windows

Instalaremos o Composer no Windows para baixar as nossas bibliotecas. Se preferir, pode seguir neste link o tutorial do próprio site oficial do Composer.

a) Primeiramente, vamos baixar o instalador do Composer para Windows neste link e, assim que o download for finalizado, execute-o;

b) Você precisará informar o caminho de instalação do seu PHP. Caso você esteja utilizando um servidor Wamp, por exemplo, e na instalação surgir uma mensagem relacionada ao arquivo "openssl", você precisará informar seu arquivo *.exe do PHP contido no diretório raiz do Wamp (geralmente em \wamp\bin\php\php.7.2\). Cabe frisar que a pasta php.7.2 refere-se a versão do PHP que está sendo utilizado na confecção dessas instruções, portanto, esse diretório poderá estar com outro nome, conforme a versão do seu PHP;

c) Durante a instalação, após indicar o diretório do seu PHP, clique em next. A instalação poderá retornar uma mensagem de alerta relacionado à configuração do "openssl". Trata-se de uma mensagem comum que significa que o "openssl" está desabilitado, contudo, vamos resolver de forma rápida e fácil.

 

 Observação

Caso não seja retornada nenhuma mensagem sobre o "openssl", apenas prossiga para o subtítulo Baixando as dependências, localizado mais abaixo.

Para habilitar seu "openssl", será necessário alterar o arquivo php.ini.

a) Abra o diretório de instalação do seu php e localize o arquivo php.ini;

b) Abra o arquivo php.ini em um editor de texto (p. ex: notepad++, sublime, etc) e pressione CTRL + F e pesquise pela palavra “openssl” (sem as aspas);

c) O sinal de ponto e vírgula ( ; ) desabilita o arquivo php_openssl.dll. Apague este sinal e ele habilitará o arquivo, ou seja:

  • Está assim: ;extension=php_openssl.dll

  • Deve ficar assim: extension=php_openssl.dll

Agora, salve o documento (pressione CTRL + S) e feche o arquivo.

d) A extensão estará habilitada e você poderá continuar com a instalação. Para que a instalação seja atualizada em relação ao procedimento, é importante que você retorne uma tela e depois avance com a instalação normalmente.

 

Baixando as dependências

a) Crie uma pasta chamada composer no seu diretório Wamp, dentro da pasta www, de forma que tenha essa estrutura: \wamp\www\composer

b) Agora, vamos realizar a instalação das dependências. Abra o prompt de comando do Windows (cmd) e navegue até o diretório raiz, em \wamp\www\composer

c) Vamos executar o comando de instalação das dependências (SDK PHP da Gerencianet) dentro desse diretório. Para tal, execute o comando abaixo:

composer require gerencianet/gerencianet-sdk-php

d) Após a execução do comando, todas as dependências serão instaladas em seu diretório, inclusive a pasta vendor com o arquivo autoload.php.

Pronto, agora é só começar a utilizar as soluções de integração da Gerencianet. Veja a tabela com os tipos de integrações.

 

3. Instalação do Composer em Linux

É possível instalar o Composer em cada projeto (instalação local) ou ter acesso a ele em qualquer parte do sistema (instalação global). Se preferir, pode seguir neste link o tutorial do próprio site oficial do Composer. Aqui, vamos efetuar a instalação global. Para tal, execute no Terminal o seguinte comando:

 

$ curl -sS https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

 

Arquivo "composer.json"

Um dos principais arquivos para se trabalhar com o Composer é o composer.json. É nele que as instruções sobre os pacotes que serão usados no projeto ficam contidas. Este é um arquivo de extensão .json comum que deve ficar na raiz de seu projeto.

A diretiva require no arquivo composer.json informa ao Composer quais os pacotes necessários para o projeto - neste caso, o repositório central é o Packagist.

Agora, vamos informar ao Composer que a Gerencianet fará parte do gerenciamento de dependências inserindo o conteúdo abaixo no final do arquivo composer.json (que deve ficar na raiz do projeto):

{"require": 
  {
    "gerencianet/gerencianet-sdk-php": "^4.*"
  }
}

É hora de instalar os pacotes. Vá até o diretório em que está seu projeto no Terminal e execute:

 

$ composer install

 

 

E pronto! 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 Gerencianet que será instalada;
  • Executar o comando de instalação no diretório do projeto: $ composer install;
  • Pronto!

 

4. Instalação biblioteca PHP da Gerencianet sem o Composer

O uso do Composer (gerenciador de dependências) é recomendável, mas não obrigatório. Caso seja de seu interesse prosseguir sem utilizá-lo, você pode baixar diretamente uma de nossas branches, descompactar e subir a pasta (inclusive o arquivo "autoload.php") para o diretório de seu projeto.

Atualmente, oferecemos quatro branches, intituladas master3.x2.x1.x, sendo:

  • master: utiliza versão recente do guzzle (^7.0.0) e é compatível com versões recentes do PHP acima da 7.2. Esta é a versão padrão quando se baixa pelo Composer, sendo indicada para todos os projetos. Acesse o Packagist.

  • 3.x: utiliza até a versão guzzle (6.0.0) e é compatível com versões do PHP (5.5, 5.6, 7.x). Acesse o Packagist.

  • 2.x: utiliza até a versão guzzle (6.0.0) e é compatível com versões do PHP (5.5, 5.6, 7.0 e 7.1). Acesse o Packagist.

  • 1.x: versão anterior da SDK, compatível com PHP 5.4 e 5.5 e utiliza guzzle 5.3.0. Baixe neste link.

A branch master é a default, porém, você pode instalar a branch 1.x. No decorrer desta página você encontrará orientações para as duas versões.

Importante reforçar que o conteúdo presente neste .zip é apenas um requisito para que você possa começar a utilizar a SDK em PHP da Gerencianet. Esta pasta por si só não é um "exemplo pronto" de uso da API Gerencianet, mas a SDK em PHP da Gerencianet que permite a utilização da API.

 

5. Erros Comuns (cURL error 60 ou cURL error 77)

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

 

cURL error 60

cURL error 77

Instalando versão mais recente da SDK PHP da Gerencianet via GitHub com o Git, Maykon Silveira, Glossário com os termos mais comuns relacionados a API e Integrações no gerencianet, Cursos online completos e gratuitos, curso php 8, curso node.js, curso de react, curso de react.js, curso de arduino, curso de html, curso de css, curso javascript, Maykon Silveira, criando api com Maykon Silveira, curso de sheep php, sheep php


Maykon Silveira

Maykon Silveira

CEO / FOUNDER / WEBTEC TECHNOLOGIES
Programador: PHP - HTML - CSS - JAVASCRIPT - MYSQLI - ANDROID - APPLE - MOBILE
Criador de Games: XBOX - PLAYSTATION - MOBILE - COMPUTADORES - EDIÇÃO DE VÍDEOS
Marketing: GOOGLE ADWORDS- FACEBOOK ADS - YOUTUBE
Experiência na área de programação desde 2007.

Alguns Depoimentos dos Alunos Maykon Silveira EAD

Vejam o que os alunos da EAD Maykon Silveira estão falando sobre os cursos.

Política de Privacidade Termos e Condições