{"_id":"575aeffae12cf20e002f3072","body":"[block:html]\n{\n  \"html\": \"<p>Se você é um desenvolvedor e pretende integrar seu site ou aplicação a um <strong>sistema completo de gestão de cobranças e pagamentos online</strong>, você está no lugar certo!</p>\\n\\n<p>Esta documentação é destinada a desenvolvedores que desejam <strong>integrar seu site ou aplicação com a API da Gerencianet</strong>. São descritas as funcionalidades da API, módulos, parâmetros técnicos, vídeos em formato de aulas sobre integrações com nossa API e disponibilização de códigos prontos de exemplos para facilitar suas atividades de desenvolvimento.</p>\\n\\n<p>A <strong>Gerencianet</strong> é uma empresa <strong>Intermediadora de Pagamentos</strong>. Por meio dela, você pode emitir cobranças para seus clientes (por boleto, cartão, carnê ou assinaturas) sem ter que realizar convênios específicos com bancos ou operadoras de cartão de crédito. Atendendo a determinação da <abbr title=\\\"Federação Brasileira de Bancos\\\">Febraban</abbr>, <strong>os boletos e carnês gerados pela Gerencianet são registrados.</strong></p>\"\n}\n[/block]\n# 1. Começando...\n[block:html]\n{\n  \"html\": \"<p>Antes de iniciar, <a href=\\\"https://gerencianet.com.br/#abrirconta\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">crie sua conta</a> na Gerencianet.</p>\\n<p>Um integrador pode criar quantas aplicações desejar. Para cada aplicação, são gerados 2 pares de chaves <code>Client_Id</code> e <code>Client_Secret</code>, sendo um par para utilização em ambiente de <abbr title=\\\"Ambiente de testes (sandbox) da Gerencianet\\\">desenvolvimento</abbr> (<a href=\\\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">?</a>) e outro para <abbr title=\\\"Ambiente de produção (usar após testar sua integração)\\\">produção</abbr> (<a href=\\\"http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">?</a>).</p>\\n<p>Utilizando a API da Gerencianet, o integrador pode gerar transações (pagamento via <a href=\\\"https://dev.gerencianet.com.br/docs/gerar-boleto\\\" title=\\\"Link Interno\\\">boleto</a> ou <a href=\\\"https://dev.gerencianet.com.br/docs/pagamento-cartao\\\" title=\\\"Link Interno\\\">cartão</a>), <a href=\\\"https://dev.gerencianet.com.br/docs/criando-assinaturas\\\" title=\\\"Link Interno\\\">cobranças recorrentes</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/carnes-criando\\\" title=\\\"Link Interno\\\">carnês</a> e <a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" title=\\\"Link Interno\\\">receber notificações</a> <em>(callbacks)</em> sempre que houver alterações de status nas transações.</p>\\n<p>Para criar sua primeira aplicação, <a href=\\\"https://gerencianet.com.br/#login\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">faça login</a> em sua conta Gerencianet, acesse o menu superior <a href=\\\"http://docs.gerencianet.com.br\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">API</a>, depois clique em <code>Minhas Aplicações > Nova Aplicação</code> (<a href=\\\"http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">?</a>) para criar sua primeira aplicação e ter acesso à tela de <a href=\\\"https://dev.gerencianet.com.br/docs/playground\\\" title=\\\"Link Interno\\\">Playground</a>. Essa tela mostra todos os <em>endpoints</em> disponibilizados pela API, ou seja, tudo que é possível realizar via integração.</p>\\n<p>Através da sub-aba <code>Histórico de Requisições</code> (<a href=\\\"http://image.prntscr.com/image/acd5c4f056a7468eaba7b701135fe98f.png\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">?</a>) é possível visualizar todas as requisições realizadas por sua aplicação à nossa API. Saiba mais na página <a href=\\\"https://dev.gerencianet.com.br/docs/interpretando-erros-api\\\" title=\\\"Link Interno\\\">Interpretando Erros na API</a>.</p>\\n<p>Tendo em vista a variedade de integrações com a Gerencianet, reunimos <a href=\\\"https://dev.gerencianet.com.br/docs/tipos-integracoes\\\" title=\\\"Link Interno\\\">nesta tabela</a> informações para facilitar sua escolha. Por isso, escolha a melhor integração, de acordo com suas necessidades.</p>\"\n}\n[/block]\n# 2. Bibliotecas\n[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>. Todas as bibliotecas disponibilizadas aqui já estão preparadas para realizar essa autenticação automaticamente.</p>\\n\\n<p>Clique na aba referente à linguagem de sua preferência para baixar a biblioteca:</p>\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Instalando via Packagist com o Composer:\\n// Packagist: https://packagist.org/packages/gerencianet/gerencianet-sdk-php\\n// Composer: https://getcomposer.org/\\n\\n$ composer require gerencianet/gerencianet-sdk-php\\n\\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-php\\n\\n// extensões cURL, json & openssl devem estar ativadas\",\n      \"language\": \"php\"\n    },\n    {\n      \"code\": \"// Instalando via NPM (https://www.npmjs.com/package/gn-api-sdk-node):\\n\\n$ npm install gn-api-sdk-node\\n\\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs\",\n      \"language\": \"javascript\",\n      \"name\": \"NodeJS\"\n    },\n    {\n      \"code\": \"// Instalando via RubyGems (https://rubygems.org/gems/gerencianet):\\n\\n$ gem install gerencianet\\n\\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby\",\n      \"language\": \"ruby\",\n      \"name\": null\n    },\n    {\n      \"code\": \"// Instalando via Pip (https://pypi.python.org/pypi/pip):\\n\\n$ pip install gerencianet\\n\\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-python\",\n      \"language\": \"python\"\n    },\n    {\n      \"code\": \"// Instalando via NuGet (https://www.nuget.org/):\\n\\n$ nuget install Gerencianet.SDK\\n  \\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet\",\n      \"language\": \"asp\",\n      \"name\": \".NET\"\n    },\n    {\n      \"code\": \"// Instalando via gradle:\\ncompile 'br.com.gerencianet.gnsdk:gn-api-sdk-java:0.2.2'\\n\\n// Instalando via maven:\\n<dependency>\\n    <groupId>br.com.gerencianet.gnsdk</groupId>\\n    <artifactId>gn-api-sdk-java</artifactId>\\n    <version>0.2.2</version>\\n</dependency>\\n// O Maven automaticamente instalará a SDK e todas as suas dependências.\\n\\n// Ou, se preferir, confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-java\",\n      \"language\": \"java\"\n    },\n    {\n      \"code\": \"// Confira a documentação completa:\\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi\",\n      \"language\": \"text\",\n      \"name\": \"Delphi\"\n    }\n  ]\n}\n[/block]\n# 3. Recursos oferecidos pela API da Gerencianet\n\n## Aprenda a instalar nossa API\n[block:html]\n{\n  \"html\": \"<p>Veja como é fácil instalar nossa SDK e integrar em seu site ou sistema. Disponibilizamos em 7 (sete) linguagens:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-php\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">PHP</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">NodeJS</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ruby</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-python\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Python</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">.NET</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-java\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Java</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Delphi</button></a>\"\n}\n[/block]\n## Criar transação e pagar com boleto ou cartão\n[block:html]\n{\n  \"html\": \"<p>Receba de seus clientes sem burocracias bancárias. Todos os boletos e carnês gerados pela Gerencianet são registrados. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/gerar-boleto\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Gerar boleto bancário</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/pagamento-cartao\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Pagamento com cartão</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-transacoes\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n## Cobranças recorrentes (assinaturas)\n[block:html]\n{\n  \"html\": \"<p>Cobre seus clientes de forma recorrente. Assim que ele autoriza os débitos, você não precisa se preocupar em enviar a cobrança todo mês e seu cliente não corre o risco de esquecer de realizar o pagamento. É possível utilizar tanto via cartão de crédito quanto boleto bancário. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/criando-assinaturas\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Criando assinaturas</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Outros endpoints e métodos</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/assinaturas-como-funcionam\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Como funciona</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-assinaturas\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n## Gere carnês para seus clientes\n[block:html]\n{\n  \"html\": \"<p>O carnê é ideal para quem realiza vendas parceladas e também para quem trabalha com mensalidades. Você pode emitir carnês com até 12 parcelas. As parcelas vencem mensalmente, de acordo com a data definida pelo integrador. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/carnes-criando\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Criando carnês</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/carnes-outros-endpoints\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Outros endpoints e métodos</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/carnes-como-funcionam\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Como funciona</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-carnes\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n\n## Ambiente de testes (sandbox) da API\n[block:html]\n{\n  \"html\": \"<p>Antes de colocar uma aplicação em produção, é muito importante certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam.</p>\\n\\n<p>Para evitar que os integradores tenham que fazer testes em produção, a Gerencianet oferece um ambiente de desenvolvimento/testes (sandbox), no qual chamamos de \\\"Playground\\\". Este é um local no qual o integrador pode utilizar para conhecer o mecanismo e o fluxo de pagamento em um ambiente 100% de teste e descomplicado. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Introdução ao Playground</button></a>\"\n}\n[/block]\n## Marketplace Gerencianet\n[block:html]\n{\n  \"html\": \"<p>O conceito de marketplace é simples. Trata-se de um ambiente virtual no qual vários vendedores distintos se reúnem para oferecer diferentes produtos e serviços, tudo em um único local, como um <em>shopping center</em>. Ao final da venda em um marketplace, o repasse automático do valor será destinado a todos os envolvidos, de acordo com as regras definidas previamente pelo integrador. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/marketplace-recebimentos\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Dividindo recebimentos</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/marketplace-como-funciona\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Como funciona</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-transacoes\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n## Módulos e Plugins para diversas plataformas\n[block:html]\n{\n  \"html\": \"<p>Possuímos módulos integrados para inúmeras plataformas - ideal também para <em>não desenvolvedores</em>. Confira os passos para instalação e configuração:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/wordpress-woocommerce\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">WordPress (WooCommerce)</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/magento\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Magento</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/opencart\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">OpenCart</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/prestashop\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">PrestaShop</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/whmcs\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">WHMCS</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/box-billing\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Box Billing</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/joomla-virtuemart\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Joomla (VirtueMart)</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/outros-modulos\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Outros</button></a>\"\n}\n[/block]\n## Link de Pagamento\n[block:html]\n{\n  \"html\": \"<p>Este recurso permite criar um link para uma tela de pagamento da Gerencianet. Com isso, o integrador não precisa implementar sua própria tela de pagamento, podendo definir as formas de pagamento que deseja permitir (boleto e/ou cartão) e, com o link gerado, o pagador será redirecionado para a tela de pagamento da Gerencianet. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/link-pagamento-criando\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Criando link de pagamento</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-transacoes\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n## Seja notificado quando uma transação for paga\n[block:html]\n{\n  \"html\": \"<p>As notificações <em>(callbacks)</em> permitem que você seja informado quando uma transação tiver seu status alterado. Dessa forma, você poderá identificar quando um boleto foi pago ou permanece em aberto, por exemplo. Saiba mais:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Recebendo as notificações</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/playground-notificacoes\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ambiente de testes</button></a>\"\n}\n[/block]\n## Exemplos de integrações API Gerencianet\n[block:html]\n{\n  \"html\": \"<p>Disponibilizamos exemplos prontos de integrações com a API da Gerencianet para você ver como é fácil adaptar nossas soluções ao seu negócio. Você pode conferir online e efetuar o download, confira:</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-assinaturas\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Assinaturas</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-boleto\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Boleto Bancário</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-cartao\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Cartão de Crédito</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-carnes\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Carnês</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-link\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Link de Pagamento</button></a>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/exemplo-integracao-marketplace\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Marketplace</button></a>\"\n}\n[/block]\n## Vídeos sobre integrações com a API Gerencianet\n[block:html]\n{\n  \"html\": \"<p>Assista os vídeos explicativos em formato de aulas sobre como utilizar nossas soluções em pagamentos online e integrar seu sistema ou aplicação com a API Gerencianet.</p>\\n\\n<a href=\\\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\\\" title=\\\"Link Interno\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Curso Online de Integrações</button></a>\"\n}\n[/block]\n## Quer conhecer mais detalhes?\n\nNavegue pelas demais seções da nossa documentação para conhecer e explorar os recursos e possibilidades de integrações que a Gerencianet oferece.\n\n<br>\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Neste momento, você já conheceu um pouco sobre a Gerencianet e as soluções em geral da nossa API. Agora, você pode conferir a <a href=\\\"https://dev.gerencianet.com.br/docs/tipos-integracoes\\\" title=\\\"Link Interno\\\">tabela com os tipos de integrações</a>, explorar o nosso <a href=\\\"https://dev.gerencianet.com.br/docs/playground\\\" title=\\\"Link Interno\\\">ambiente de testes</a>, visualizar o <a href=\\\"https://dev.gerencianet.com.br/docs/visao-geral-fluxo-integracao\\\" title=\\\"Link Interno\\\">fluxo geral de integração com a Gerencianet</a>, além de ver como criar sua primeira cobrança (pagamento por <a href=\\\"https://dev.gerencianet.com.br/docs/gerar-boleto\\\" title=\\\"Link Interno\\\">boleto</a> ou <a href=\\\"https://dev.gerencianet.com.br/docs/pagamento-cartao\\\" title=\\\"Link Interno\\\">cartão</a>).\",\n  \"title\": \"PRÓXIMOS PASSOS\"\n}\n[/block]","githubsync":"","hidden":false,"link_url":"","order":0,"slug":"introducao","__v":108,"api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"sync_unique":"","title":"Introdução","link_external":false,"next":{"description":"","pages":[]},"user":"575aefbea083950e004487f2","category":"575aeffae12cf20e002f3070","isReference":true,"excerpt":"Você está em: *\"Visão Geral da API > Introdução\"*","type":"basic","parentDoc":null,"project":"575aeffae12cf20e002f306c","updates":["575efd078925ce1900e923c8"],"version":"575aeffae12cf20e002f306f","createdAt":"2016-06-10T16:51:06.130Z","childrenPages":[]}

Introdução

Você está em: *"Visão Geral da API > Introdução"*

[block:html] { "html": "<p>Se você é um desenvolvedor e pretende integrar seu site ou aplicação a um <strong>sistema completo de gestão de cobranças e pagamentos online</strong>, você está no lugar certo!</p>\n\n<p>Esta documentação é destinada a desenvolvedores que desejam <strong>integrar seu site ou aplicação com a API da Gerencianet</strong>. São descritas as funcionalidades da API, módulos, parâmetros técnicos, vídeos em formato de aulas sobre integrações com nossa API e disponibilização de códigos prontos de exemplos para facilitar suas atividades de desenvolvimento.</p>\n\n<p>A <strong>Gerencianet</strong> é uma empresa <strong>Intermediadora de Pagamentos</strong>. Por meio dela, você pode emitir cobranças para seus clientes (por boleto, cartão, carnê ou assinaturas) sem ter que realizar convênios específicos com bancos ou operadoras de cartão de crédito. Atendendo a determinação da <abbr title=\"Federação Brasileira de Bancos\">Febraban</abbr>, <strong>os boletos e carnês gerados pela Gerencianet são registrados.</strong></p>" } [/block] # 1. Começando... [block:html] { "html": "<p>Antes de iniciar, <a href=\"https://gerencianet.com.br/#abrirconta\" target=\"_blank\" title=\"Link Externo\">crie sua conta</a> na Gerencianet.</p>\n<p>Um integrador pode criar quantas aplicações desejar. Para cada aplicação, são gerados 2 pares de chaves <code>Client_Id</code> e <code>Client_Secret</code>, sendo um par para utilização em ambiente de <abbr title=\"Ambiente de testes (sandbox) da Gerencianet\">desenvolvimento</abbr> (<a href=\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\" target=\"_blank\" title=\"Link Externo\">?</a>) e outro para <abbr title=\"Ambiente de produção (usar após testar sua integração)\">produção</abbr> (<a href=\"http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png\" target=\"_blank\" title=\"Link Externo\">?</a>).</p>\n<p>Utilizando a API da Gerencianet, o integrador pode gerar transações (pagamento via <a href=\"https://dev.gerencianet.com.br/docs/gerar-boleto\" title=\"Link Interno\">boleto</a> ou <a href=\"https://dev.gerencianet.com.br/docs/pagamento-cartao\" title=\"Link Interno\">cartão</a>), <a href=\"https://dev.gerencianet.com.br/docs/criando-assinaturas\" title=\"Link Interno\">cobranças recorrentes</a>, <a href=\"https://dev.gerencianet.com.br/docs/carnes-criando\" title=\"Link Interno\">carnês</a> e <a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" title=\"Link Interno\">receber notificações</a> <em>(callbacks)</em> sempre que houver alterações de status nas transações.</p>\n<p>Para criar sua primeira aplicação, <a href=\"https://gerencianet.com.br/#login\" target=\"_blank\" title=\"Link Externo\">faça login</a> em sua conta Gerencianet, acesse o menu superior <a href=\"http://docs.gerencianet.com.br\" target=\"_blank\" title=\"Link Externo\">API</a>, depois clique em <code>Minhas Aplicações > Nova Aplicação</code> (<a href=\"http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png\" target=\"_blank\" title=\"Link Externo\">?</a>) para criar sua primeira aplicação e ter acesso à tela de <a href=\"https://dev.gerencianet.com.br/docs/playground\" title=\"Link Interno\">Playground</a>. Essa tela mostra todos os <em>endpoints</em> disponibilizados pela API, ou seja, tudo que é possível realizar via integração.</p>\n<p>Através da sub-aba <code>Histórico de Requisições</code> (<a href=\"http://image.prntscr.com/image/acd5c4f056a7468eaba7b701135fe98f.png\" target=\"_blank\" title=\"Link Externo\">?</a>) é possível visualizar todas as requisições realizadas por sua aplicação à nossa API. Saiba mais na página <a href=\"https://dev.gerencianet.com.br/docs/interpretando-erros-api\" title=\"Link Interno\">Interpretando Erros na API</a>.</p>\n<p>Tendo em vista a variedade de integrações com a Gerencianet, reunimos <a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" title=\"Link Interno\">nesta tabela</a> informações para facilitar sua escolha. Por isso, escolha a melhor integração, de acordo com suas necessidades.</p>" } [/block] # 2. Bibliotecas [block:html] { "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>. Todas as bibliotecas disponibilizadas aqui já estão preparadas para realizar essa autenticação automaticamente.</p>\n\n<p>Clique na aba referente à linguagem de sua preferência para baixar a biblioteca:</p>" } [/block] [block:code] { "codes": [ { "code": "// Instalando via Packagist com o Composer:\n// Packagist: https://packagist.org/packages/gerencianet/gerencianet-sdk-php\n// Composer: https://getcomposer.org/\n\n$ composer require gerencianet/gerencianet-sdk-php\n\n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-php\n\n// extensões cURL, json & openssl devem estar ativadas", "language": "php" }, { "code": "// Instalando via NPM (https://www.npmjs.com/package/gn-api-sdk-node):\n\n$ npm install gn-api-sdk-node\n\n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs", "language": "javascript", "name": "NodeJS" }, { "code": "// Instalando via RubyGems (https://rubygems.org/gems/gerencianet):\n\n$ gem install gerencianet\n\n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby", "language": "ruby", "name": null }, { "code": "// Instalando via Pip (https://pypi.python.org/pypi/pip):\n\n$ pip install gerencianet\n\n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-python", "language": "python" }, { "code": "// Instalando via NuGet (https://www.nuget.org/):\n\n$ nuget install Gerencianet.SDK\n \n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet", "language": "asp", "name": ".NET" }, { "code": "// Instalando via gradle:\ncompile 'br.com.gerencianet.gnsdk:gn-api-sdk-java:0.2.2'\n\n// Instalando via maven:\n<dependency>\n <groupId>br.com.gerencianet.gnsdk</groupId>\n <artifactId>gn-api-sdk-java</artifactId>\n <version>0.2.2</version>\n</dependency>\n// O Maven automaticamente instalará a SDK e todas as suas dependências.\n\n// Ou, se preferir, confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-java", "language": "java" }, { "code": "// Confira a documentação completa:\n// https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi", "language": "text", "name": "Delphi" } ] } [/block] # 3. Recursos oferecidos pela API da Gerencianet ## Aprenda a instalar nossa API [block:html] { "html": "<p>Veja como é fácil instalar nossa SDK e integrar em seu site ou sistema. Disponibilizamos em 7 (sete) linguagens:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-php\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">PHP</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">NodeJS</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ruby</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-python\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Python</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">.NET</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-java\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Java</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Delphi</button></a>" } [/block] ## Criar transação e pagar com boleto ou cartão [block:html] { "html": "<p>Receba de seus clientes sem burocracias bancárias. Todos os boletos e carnês gerados pela Gerencianet são registrados. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/gerar-boleto\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Gerar boleto bancário</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/pagamento-cartao\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Pagamento com cartão</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-transacoes\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Cobranças recorrentes (assinaturas) [block:html] { "html": "<p>Cobre seus clientes de forma recorrente. Assim que ele autoriza os débitos, você não precisa se preocupar em enviar a cobrança todo mês e seu cliente não corre o risco de esquecer de realizar o pagamento. É possível utilizar tanto via cartão de crédito quanto boleto bancário. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/criando-assinaturas\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Criando assinaturas</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Outros endpoints e métodos</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/assinaturas-como-funcionam\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Como funciona</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-assinaturas\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Gere carnês para seus clientes [block:html] { "html": "<p>O carnê é ideal para quem realiza vendas parceladas e também para quem trabalha com mensalidades. Você pode emitir carnês com até 12 parcelas. As parcelas vencem mensalmente, de acordo com a data definida pelo integrador. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/carnes-criando\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Criando carnês</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/carnes-outros-endpoints\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Outros endpoints e métodos</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/carnes-como-funcionam\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Como funciona</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-carnes\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Ambiente de testes (sandbox) da API [block:html] { "html": "<p>Antes de colocar uma aplicação em produção, é muito importante certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam.</p>\n\n<p>Para evitar que os integradores tenham que fazer testes em produção, a Gerencianet oferece um ambiente de desenvolvimento/testes (sandbox), no qual chamamos de \"Playground\". Este é um local no qual o integrador pode utilizar para conhecer o mecanismo e o fluxo de pagamento em um ambiente 100% de teste e descomplicado. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Introdução ao Playground</button></a>" } [/block] ## Marketplace Gerencianet [block:html] { "html": "<p>O conceito de marketplace é simples. Trata-se de um ambiente virtual no qual vários vendedores distintos se reúnem para oferecer diferentes produtos e serviços, tudo em um único local, como um <em>shopping center</em>. Ao final da venda em um marketplace, o repasse automático do valor será destinado a todos os envolvidos, de acordo com as regras definidas previamente pelo integrador. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/marketplace-recebimentos\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Dividindo recebimentos</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/marketplace-como-funciona\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Como funciona</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-transacoes\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Módulos e Plugins para diversas plataformas [block:html] { "html": "<p>Possuímos módulos integrados para inúmeras plataformas - ideal também para <em>não desenvolvedores</em>. Confira os passos para instalação e configuração:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/wordpress-woocommerce\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">WordPress (WooCommerce)</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/magento\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Magento</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/opencart\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">OpenCart</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/prestashop\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">PrestaShop</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/whmcs\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">WHMCS</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/box-billing\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Box Billing</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/joomla-virtuemart\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Joomla (VirtueMart)</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/outros-modulos\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Outros</button></a>" } [/block] ## Link de Pagamento [block:html] { "html": "<p>Este recurso permite criar um link para uma tela de pagamento da Gerencianet. Com isso, o integrador não precisa implementar sua própria tela de pagamento, podendo definir as formas de pagamento que deseja permitir (boleto e/ou cartão) e, com o link gerado, o pagador será redirecionado para a tela de pagamento da Gerencianet. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/link-pagamento-criando\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Criando link de pagamento</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-transacoes\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Seja notificado quando uma transação for paga [block:html] { "html": "<p>As notificações <em>(callbacks)</em> permitem que você seja informado quando uma transação tiver seu status alterado. Dessa forma, você poderá identificar quando um boleto foi pago ou permanece em aberto, por exemplo. Saiba mais:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Recebendo as notificações</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/playground-notificacoes\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ambiente de testes</button></a>" } [/block] ## Exemplos de integrações API Gerencianet [block:html] { "html": "<p>Disponibilizamos exemplos prontos de integrações com a API da Gerencianet para você ver como é fácil adaptar nossas soluções ao seu negócio. Você pode conferir online e efetuar o download, confira:</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-assinaturas\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Assinaturas</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-boleto\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Boleto Bancário</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-cartao\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Cartão de Crédito</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-carnes\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Carnês</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-link\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Link de Pagamento</button></a>\n\n<a href=\"https://dev.gerencianet.com.br/docs/exemplo-integracao-marketplace\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Marketplace</button></a>" } [/block] ## Vídeos sobre integrações com a API Gerencianet [block:html] { "html": "<p>Assista os vídeos explicativos em formato de aulas sobre como utilizar nossas soluções em pagamentos online e integrar seu sistema ou aplicação com a API Gerencianet.</p>\n\n<a href=\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\" title=\"Link Interno\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Curso Online de Integrações</button></a>" } [/block] ## Quer conhecer mais detalhes? Navegue pelas demais seções da nossa documentação para conhecer e explorar os recursos e possibilidades de integrações que a Gerencianet oferece. <br> [block:callout] { "type": "info", "body": "Neste momento, você já conheceu um pouco sobre a Gerencianet e as soluções em geral da nossa API. Agora, você pode conferir a <a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" title=\"Link Interno\">tabela com os tipos de integrações</a>, explorar o nosso <a href=\"https://dev.gerencianet.com.br/docs/playground\" title=\"Link Interno\">ambiente de testes</a>, visualizar o <a href=\"https://dev.gerencianet.com.br/docs/visao-geral-fluxo-integracao\" title=\"Link Interno\">fluxo geral de integração com a Gerencianet</a>, além de ver como criar sua primeira cobrança (pagamento por <a href=\"https://dev.gerencianet.com.br/docs/gerar-boleto\" title=\"Link Interno\">boleto</a> ou <a href=\"https://dev.gerencianet.com.br/docs/pagamento-cartao\" title=\"Link Interno\">cartão</a>).", "title": "PRÓXIMOS PASSOS" } [/block]