{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"PHP","type":"basic","slug":"instalacao-sdk-php","excerpt":"Saiba como instalar e configurar nossa SDK em PHP para API Pix e API Boletos (Bolix)","body":"[block:html]\n{\n  \"html\": \"<p>Nossa API é <a href=\\\"https://en.wikipedia.org/wiki/Representational_state_transfer\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">RESTful</a> e responde em <a href=\\\"http://www.json.org/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">JSON</a>. A Gerencianet utiliza <a href=\\\"http://oauth.net/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">OAuth</a> para fornecer acesso autorizado à <abbr title=\\\"Application Programming Interface\\\">API</abbr>. Nossa SDK de PHP já está preparada para realizar essa autenticação automaticamente.</p>\"\n}\n[/block]\nA seguir, confira os procedimentos para instalação da <a href=\"https://github.com/gerencianet/gn-api-sdk-php\" target=\"_blank\" title=\"Link Externo\">SDK da Gerencianet em PHP</a>:\n\n# Instalando via <a href=\"https://packagist.org/packages/gerencianet/gerencianet-sdk-php\" target=\"_blank\" title=\"Link Externo\">Packagist</a> com o <a href=\"https://getcomposer.org/\" target=\"_blank\" title=\"Link Externo\">Composer</a>\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php\",\n      \"language\": \"shell\",\n      \"name\": \"Branch 4.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:3.1.0\",\n      \"language\": \"shell\",\n      \"name\": \"Branch 3.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:2.4.1\",\n      \"language\": \"shell\",\n      \"name\": \"Branch 2.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:1.0.17\",\n      \"language\": \"shell\",\n      \"name\": \"Branch 1.x\"\n    }\n  ]\n}\n[/block]\n# Instalando versão mais recente via <a href=\"https://github.com/gerencianet/gn-api-sdk-php\" target=\"_blank\" title=\"Link Externo\">GitHub</a> com o <a href=\"https://git-scm.com/\" target=\"_blank\" title=\"Link Externo\">Git</a>\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"git clone https://github.com/gerencianet/gn-api-sdk-php.git\\ncd gn-api-sdk-php/\\ncomposer install\",\n      \"language\": \"text\",\n      \"name\": \"Release 4.x\"\n    }\n  ]\n}\n[/block]\nÉ importante frisar que as extensões <code>cURL</code>, <code>json</code>, <code>ext-simplexml</code> & <code>openssl</code> devem estar ativadas.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"IMPORTANTE\",\n  \"body\": \"Atualmente, disponibilizamos quatro versões da SDK. A versão 1.x é compatível com versões do PHP superiores à versão 5.4, no entanto, possui alguns componentes desatualizados, como o Guzzle. Caso você tenha uma versão do PHP superior à 5.5 e inferior a 7.0, sugerimos é possível utilizar as versões 2.x e 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.\"\n}\n[/block]\nVá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa:\n\n1. [Pré-requisitos](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-1-pr-requisitos)\n\n2. [Instalação do Composer em Windows](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-2-instala-o-do-composer-em-windows)\n\n3. [Instalação do Composer em Linux](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-3-instala-o-do-composer-em-linux)\n\n4. [Instalação biblioteca PHP da Gerencianet sem o Composer](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-4-instala-o-biblioteca-php-da-gerencianet-sem-o-composer)\n\n5. [Erros Comuns (cURL error 60 ou cURL error 77)](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-5-erros-comuns-curl-error-60-ou-curl-error-77-)\n\n6. [Vídeo: Instalação do Composer (Windows e Linux)](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-6-v-deo-instala-o-do-composer-windows-e-linux-)\n\n7. [Extra: timeout option](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-7-extra-timeout-option)\n\n# 1. Pré-requisitos\n\nOs seguintes pré-requisitos devem ser considerados, de acordo com a *branch* utilizada:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Versão da branch\",\n    \"h-1\": \"Status\",\n    \"0-1\": \"Mantido\",\n    \"1-1\": \"Mantido\",\n    \"h-2\": \"Packagist\",\n    \"h-3\": \"Repositório\",\n    \"h-4\": \"Versão do PHP\",\n    \"0-0\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/1.x\\\" target=\\\"_blank\\\">1.x</a>\",\n    \"1-0\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/2.x\\\" target=\\\"_blank\\\">2.x</a>\",\n    \"0-2\": \"<code>gerencianet/gerencianet-sdk-php:1.0.17</code>\",\n    \"1-2\": \"<code>gerencianet/gerencianet-sdk-php:2.4.1</code>\",\n    \"0-3\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/1.x\\\" target=\\\"_blank\\\">v1</a>\",\n    \"1-3\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/2.x\\\" target=\\\"_blank\\\">v2</a>\",\n    \"0-4\": \"<code>> =</code> 5.4 (não é compatível com PHP 7.x)\",\n    \"1-4\": \"<code>> =</code> 5.5 (compatível com PHP 7.x)\",\n    \"2-0\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/3.x\\\" target=\\\"_blank\\\">3.x</a>\",\n    \"2-3\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php/tree/3.x\\\" target=\\\"_blank\\\">v3</a>\",\n    \"2-4\": \"<code>> =</code> 5.6 (compatível com PHP 7.x e Guzzle <= 6.5.2)\",\n    \"2-2\": \"<code>gerencianet/gerencianet-sdk-php:3.1.0</code>\",\n    \"2-1\": \"Mantido\",\n    \"3-0\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php\\\" target=\\\"_blank\\\">4.x</a>\",\n    \"3-3\": \"<a href=\\\"https://github.com/gerencianet/gn-api-sdk-php\\\" target=\\\"_blank\\\">v4</a>\",\n    \"3-1\": \"Mantido\",\n    \"3-2\": \"<code>gerencianet/gerencianet-sdk-php</code>\",\n    \"3-4\": \"<code>> =</code> 7.2\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"Para a utilização da biblioteca em PHP, recomendamos a instalação através do <a href=\\\"https://getcomposer.org/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">Composer</a> (gerenciador de dependências).\\n\\nCaso prefira prosseguir sem o Composer, basta seguir os procedimentos descritos no título [4. Instalação biblioteca PHP da Gerencianet sem o Composer](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-4-instala-o-biblioteca-php-da-gerencianet-sem-o-composer).\",\n  \"title\": \"Nota:\"\n}\n[/block]\n# 2. Instalação do Composer em Windows\n\nInstalaremos o Composer no Windows para baixar as nossas bibliotecas. Se preferir, pode seguir <a href=\"https://getcomposer.org/doc/00-intro.md#installation-windows\" target=\"_blank\" title=\"[link externo]\">neste link</a> o tutorial do próprio site oficial do Composer.\n\na) Primeiramente, vamos baixar o instalador do Composer para Windows <a href=\"https://getcomposer.org/Composer-Setup.exe\" target=\"_blank\" title=\"[link externo]\">neste link</a> e, assim que o download for finalizado, execute-o;\n\nb) 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 <code>*.exe</code> do PHP contido no diretório raiz do Wamp (geralmente em <code>\\wamp\\bin\\php\\php.7.2\\</code>). Cabe frisar que a pasta <code>php.7.2</code> 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;\n\nc) Durante a instalação, após indicar o diretório do seu PHP, clique em <code>next</code>. 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.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Observação\",\n  \"body\": \"Caso não seja retornada nenhuma mensagem sobre o \\\"openssl\\\", apenas prossiga para o subtítulo [Baixando as dependências](https://dev.gerencianet.com.br/docs/instalacao-sdk-php#section-baixando-as-depend-ncias), localizado mais abaixo.\"\n}\n[/block]\nPara habilitar seu \"openssl\", será necessário alterar o arquivo <code>php.ini</code>.\n\na) Abra o diretório de instalação do seu php e localize o arquivo <code>php.ini</code>;\n\nb) Abra o arquivo <code>php.ini</code> em um editor de texto (p. ex: notepad++, sublime, etc) e pressione <code>CTRL + F</code> e pesquise pela palavra “openssl” (sem as aspas);\n\nc) O sinal de ponto e vírgula ( ; ) desabilita o arquivo <code>php_openssl.dll</code>. Apague este sinal e ele habilitará o arquivo, ou seja:\n\n  * Está assim: <code>;extension=php_openssl.dll</code>\n\n  * Deve ficar assim: <code>extension=php_openssl.dll</code>\n\nAgora, salve o documento (pressione <code>CTRL + S</code>) e feche o arquivo.\n\nd) 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.\n\n## Baixando as dependências\n\na) Crie uma pasta chamada <code>composer</code> no seu diretório Wamp, dentro da pasta <code>www</code>, de forma que tenha essa estrutura: <code>\\wamp\\www\\composer</code>\n\nb) 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 <code>\\wamp\\www\\composer</code>\n\nc) Vamos executar o comando de instalação das dependências (SDK PHP da Gerencianet) dentro desse diretório. Para tal, execute o comando abaixo:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php\",\n      \"language\": \"text\",\n      \"name\": \"Branch 4.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:3.1.0\",\n      \"language\": \"text\",\n      \"name\": \"Branch 3.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:2.4.1\",\n      \"language\": \"text\",\n      \"name\": \"Branch 2.x\"\n    },\n    {\n      \"code\": \"composer require gerencianet/gerencianet-sdk-php:1.0.17\",\n      \"language\": \"text\",\n      \"name\": \"Branch 1.x\"\n    }\n  ]\n}\n[/block]\nd) Após a execução do comando, todas as dependências serão instaladas em seu diretório, inclusive a pasta <code>vendor</code> com o arquivo <code>autoload.php</code>.\n\nPronto, agora é só começar a utilizar as soluções de integração da Gerencianet. Veja a tabela com os <a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" title=\"Link Interno\">tipos de integrações</a>.\n\n\n# 3. Instalação do Composer em Linux\n\nÉ 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 <a href=\"https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx\" target=\"_blank\" title=\"[link externo]\">neste link</a> o tutorial do próprio site oficial do Composer. Aqui, vamos efetuar a instalação global. Para tal, execute no Terminal o seguinte comando:\n\n<pre>$ curl -sS https://getcomposer.org/installer | php\n$ sudo mv composer.phar /usr/local/bin/composer</pre>\n\n## Arquivo \"composer.json\"\n\nUm dos principais arquivos para se trabalhar com o Composer é o <code>composer.json</code>. É nele que as instruções sobre os pacotes que serão usados no projeto ficam contidas. Este é um arquivo de extensão <code>.json</code> comum que deve ficar na raiz de seu projeto.\n\nA diretiva <code>require</code> no arquivo <code>composer.json</code> informa ao Composer quais os pacotes necessários para o projeto - neste caso, o repositório central é o Packagist.\n\nAgora, vamos informar ao Composer que a Gerencianet fará parte do gerenciamento de dependências inserindo o conteúdo abaixo no final do arquivo <code>composer.json</code> (que deve ficar na raiz do projeto):\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"require\\\": \\n\\t{\\n\\t\\t\\\"gerencianet/gerencianet-sdk-php\\\": \\\"^4.*\\\"\\n\\t}\\n}\",\n      \"language\": \"text\",\n      \"name\": \"Branch 4.x\"\n    },\n    {\n      \"code\": \"{\\\"require\\\": \\n\\t{\\n\\t\\t\\\"gerencianet/gerencianet-sdk-php\\\": \\\"3.*\\\"\\n\\t}\\n}\",\n      \"language\": \"text\",\n      \"name\": \"Branch 3.x\"\n    },\n    {\n      \"code\": \"{\\\"require\\\": \\n\\t{\\n\\t\\t\\\"gerencianet/gerencianet-sdk-php\\\": \\\"2.*\\\"\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Branch 2.x\"\n    },\n    {\n      \"code\": \"{\\\"require\\\": \\n\\t{\\n\\t\\t\\\"gerencianet/gerencianet-sdk-php\\\": \\\"1.*\\\"\\n\\t}\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Branch 1.x\"\n    }\n  ]\n}\n[/block]\nÉ hora de instalar os pacotes. Vá até o diretório em que está seu projeto no Terminal e execute:\n\n<pre>$ composer install</pre>\n\n<br>\n\nE 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 <code>composer.lock</code>.\n\nCabe frisar que, caso você necessite, por exemplo, excluir um pacote, basta deletar sua referência do arquivo <code>composer.json</code> e atualizar o Composer através do seguinte comando:\n\n<pre>$ composer update</pre>\n\n<br>\n\nDessa forma, o Composer será atualizado e, como não há mais a presença do pacote na diretiva <code>require</code>, ele será imediatamente \"desinstalado\".\n\n## Resumo:\n\n- Instalar o Composer;\n- Informar, no arquivo <code>composer.json</code>, a SDK da Gerencianet que será instalada;\n- Executar o comando de instalação no diretório do projeto: <code>$ composer install</code>;\n- Pronto!\n\n\n# 4. Instalação biblioteca PHP da Gerencianet sem o Composer\n\nO 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 <em>branches</em>, descompactar e subir a pasta (inclusive o arquivo \"autoload.php\") para o diretório de seu projeto.\n\nAtualmente, oferecemos quatro <em>branches</em>, intituladas <code>master</code>, <code>3.x</code>, <code>2.x</code>e <code>1.x</code>, sendo:\n\n- <code>master</code>: 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. <a href=\"https://packagist.org/packages/gerencianet/gerencianet-sdk-php\" target=\"_blank\" title=\"Link Externo\">Acesse o Packagist</a>.\n\n- <code>3.x</code>: utiliza  até a versão guzzle (6.0.0) e é compatível com versões do PHP (5.5, 5.6, 7.x). <a href=\"https://packagist.org/packages/gerencianet/gerencianet-sdk-php#2.4.1\" target=\"_blank\" title=\"Link Externo\">Acesse o Packagist</a>.\n\n- <code>2.x</code>: 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). <a href=\"https://packagist.org/packages/gerencianet/gerencianet-sdk-php#3.1.0\" target=\"_blank\" title=\"Link Externo\">Acesse o Packagist</a>.\n\n- <code>1.x</code>: versão anterior da SDK, compatível com PHP 5.4 e 5.5 e utiliza guzzle 5.3.0. <a href=\"https://gerencianet.com.br/material/api/php/api_v1.zip\" target=\"_blank\" title=\"Link Externo\">Baixe neste link</a>.\n\nA branch <code>master</code> é a <em>default</em>, porém, você pode instalar a branch <code>1.x</code>. No decorrer desta página você encontrará orientações para as duas versões.\n\nImportante 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.\n\n# 5. Erros Comuns (cURL error 60 ou cURL error 77)\n\nOs 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:\n\n<a href=\"https://gerencianet.com.br/artigo/curl-error-60-ou-curl-error-77-como-resolver/\" target=\"_blank\" title=\"Link Externo\"><h2>cURL error 60</h2></a>\n\n<a href=\"https://gerencianet.com.br/artigo/curl-error-60-ou-curl-error-77-como-resolver/\" target=\"_blank\" title=\"Link Externo\"><h2>cURL error 77</h2></a>\n\n# 6. Vídeo: Instalação do Composer (Windows e Linux)\n\nPensando em oferecer novos meios de transmitir informações, a Gerencianet disponibiliza os vídeos a seguir com o objetivo de explicar, de maneira clara e objetiva, como instalar o Composer no sistema operacional Windows e Linux.\n\n## Instalando o Composer via Windows\n[block:html]\n{\n  \"html\": \"<iframe width=\\\"560\\\" height=\\\"315\\\" src=\\\"https://www.youtube.com/embed/bu9tUI3dHwI\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\"\n}\n[/block]\n<br>\n\n## Instalando o Composer via Linux\n[block:html]\n{\n  \"html\": \"<iframe width=\\\"560\\\" height=\\\"315\\\" src=\\\"https://www.youtube.com/embed/uQFhNJhbzdg\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\"\n}\n[/block]\n<br>\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Para acesso as demais aulas, de outros assuntos, acesse a página <a href=\\\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\\\" title=\\\"Link Interno\\\">Curso Online de Integrações</a>.\",\n  \"title\": \"DICA\"\n}\n[/block]\n<br>\n\n<hr>\n\n# 7. Extra: timeout option\n\nEste 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 <a href=\"https://github.com/gerencianet/gn-api-sdk-php#getting-started\" target=\"_blank\" title=\"Link Externo\">nosso repositório do Github</a>.","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"606f2ca7c5ba910078783487","user":"57601a13af3e090e00108059","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Instalação da API (SDK's)","slug":"instalação-da-api-sdks","order":6,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba91007878343d","createdAt":"2017-03-10T12:37:05.075Z","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6","__v":0},"__v":0,"createdAt":"2017-03-10T13:00:29.670Z","parentDoc":null,"project":"575aeffae12cf20e002f306c","githubsync":"","version":{"version":"1.1.0","version_clean":"1.1.0","codename":"2021","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["606f2ca6c5ba91007878342b","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","606f2ca6c5ba91007878342c","606f2ca6c5ba91007878342d","606f2ca6c5ba91007878342e","606f2ca6c5ba91007878342f","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","606f2ca6c5ba910078783430","606f2ca6c5ba910078783431","5783f78c5cbce30e0074e2b7","606f2ca6c5ba910078783432","606f2ca6c5ba910078783433","606f2ca6c5ba910078783434","606f2ca6c5ba910078783435","606f2ca6c5ba910078783436","606f2ca6c5ba910078783437","578529f887c9280e0090394b","606f2ca6c5ba910078783438","606f2ca6c5ba910078783439","606f2ca6c5ba91007878343a","606f2ca6c5ba91007878343b","606f2ca6c5ba91007878343c","606f2ca6c5ba91007878343d","606f2ca6c5ba91007878343e","606f2ca6c5ba91007878343f","606f2ca6c5ba910078783440","606f2ca6c5ba910078783441","60d61f026ddc3901a32ee5f1","60ec37c637005f015e54174e"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":2,"forked_from":"575aeffae12cf20e002f306f"}}