{"__v":108,"_id":"575aeffae12cf20e002f3072","category":{"__v":0,"_id":"575aeffae12cf20e002f3070","project":"575aeffae12cf20e002f306c","version":"575aeffae12cf20e002f306f","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-06-10T16:51:06.098Z","from_sync":false,"order":0,"slug":"documentation","title":"Visão Geral da API"},"parentDoc":null,"project":"575aeffae12cf20e002f306c","user":"575aefbea083950e004487f2","version":{"__v":29,"_id":"575aeffae12cf20e002f306f","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","categories":["575aeffae12cf20e002f3070","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","57602fe5b82256240055c657","57602ff6c811102000cef302","576030909b1a9a220067ca40","57604518b82256240055c722","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","577680bf3cee3a0e00a000bc","577ff3b1ff48990e000c6806","5783f78c5cbce30e0074e2b7","5783f86292edb92200e6101c","5783f86dbfbba719003f0d8b","5783f8755cbce30e0074e2b8","5783f8b65cbce30e0074e2b9","5783f8bf5cbce30e0074e2ba","5783f8d8ce802f0e0087d574","578529f887c9280e0090394b","57852aeb87c9280e0090394d","57866e72b2f4060e00fa39ca","57ab6d5c39c2fd1900191879","57f39451ab0ee12000bef915","582499a0d90fa027009b259e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"2016","version_clean":"1.0.0","version":"1"},"updates":["575efd078925ce1900e923c8"],"next":{"pages":[],"description":""},"createdAt":"2016-06-10T16:51:06.130Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"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 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 registrado, 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## Bibliotecas\n<hr>\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, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-sdk-php\",\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, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-sdk-node\",\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, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-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, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-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, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-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.1.0'\\n\\n// Instalando via maven:\\n<dependency>\\n    <groupId>br.com.gerencianet.gnsdk</groupId>\\n    <artifactId>gn-api-sdk-java</artifactId>\\n    <version>0.1.0</version>\\n</dependency>\\n// O Maven automaticamente instalará a SDK e todas as suas dependências.\\n\\n// Ou, se preferir, baixe diretamente pela nossa página do Github:\\n// https://github.com/gerencianet/gn-api-sdk-java\",\n      \"language\": \"java\"\n    }\n  ]\n}\n[/block]\n## Começando...\n<hr>\n[block:html]\n{\n  \"html\": \"<p>Antes de iniciar, <a href=\\\"https://gerencianet.com.br/#abrirconta\\\" target=\\\"_blank\\\" title=\\\"Cadastro ao nosso sistema, seja nosso cliente\\\">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 \\\"Client_Id\\\" e \\\"Client_Secret\\\": um 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\\\">?</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\\\">?</a>).</p>\\n<p>Utilizando a API da Gerencianet, o integrador estará apto a gerar transações, definir a forma de pagamento (boleto ou cartão), gerar transações recorrentes, gerar carnês e receber notificações sempre que ocorrer uma alteração de status de uma transação.</p>\\n<p>Para criar sua primeira aplicação, <a href=\\\"https://gerencianet.com.br/#login\\\" target=\\\"_blank\\\" title=\\\"Logue em sua conta Gerencianet\\\">logue</a> em sua conta Gerencianet, acesse o menu superior <em>\\\"<a href=\\\"http://docs.gerencianet.com.br\\\" target=\\\"_blank\\\" title=\\\"API\\\">API</a>\\\"</em>, depois clique em <em>\\\"Minhas Aplicações > Nova Aplicação\\\"</em> (<a href=\\\"http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png\\\" target=\\\"_blank\\\" title=\\\"Minhas Aplicações > Nova Aplicação\\\">?</a>) para criar sua primeira aplicação e ter acesso à tela de <abbr title=\\\"Ambiente de testes (sandbox) da Gerencianet\\\">Playground</abbr>. Essa tela mostra todos os <em>endpoints</em> disponibilizados pela API, ou seja, tudo que é possível realizar via integração.</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=\\\"Tabela integrações Gerencianet\\\">nesta tabela</a> essas informações para facilitar sua escolha. Por isso, escolha a melhor integração, de acordo com suas necessidades.</p>\"\n}\n[/block]\n## Conheça alguns dos recursos oferecidos pela API da Gerencianet\n<hr>\n[block:html]\n{\n  \"html\": \"\\n\\n<div class=\\\"col-lg-12 col-md-12 col-sm-12 text-center\\\">\\n  \\n  \\n  \\n  <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>APRENDA INSTALAR A API DA GERENCIANET</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-da-api\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/mNlZ6eFCQDGBUBDH9rhd_settings%20(1).png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Veja como é fácil <a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-da-api\\\" title=\\\"[link interno]\\\">instalar nossa SDK</a> e integrar em seu site ou sistema. Disponibilizamos em seis linguagens: PHP, NodeJS, Ruby, Python, .NET e Java.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/instalacao-da-api\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n              <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>CRIAR TRANSAÇÃO E PAGAR COM BOLETO OU CARTÃO</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/WEZDHxRDSW2HeOJD2Rgn_barcode-product.png\\\"></a>\\n                              \\t+\\n                              \\t<a href=\\\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/m0QkHTIT62PT6wODA5hW_credit-cards-payment%20(1).png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Receba de seus clientes sem burocracias bancárias. Todos os boletos e carnês gerados pela Gerencianet são registrados. Conheça mais sobre pagar com <a href=\\\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\\\" title=\\\"[link interno]\\\">boleto</a> e/ou <a href=\\\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\\\" title=\\\"[link interno]\\\">cartão</a>.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Boleto</a> ou <a href=\\\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Cartão</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n  \\n  \\n  \\n  \\n  \\n  \\n  <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>COBRANÇAS RECORRENTES</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/DBKxyjPTBGd12yURWfqT_cash.png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Cobre seus clientes de <a href=\\\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\\\" title=\\\"[link interno]\\\">forma recorrente</a>. 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.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n              <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>GERE CARNÊS PARA SEUS CLIENTES</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/carnes-introducao\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/rAud18Y7T0igh53WwL2n_barcode.png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">O <a href=\\\"https://dev.gerencianet.com.br/docs/carnes-introducao\\\" title=\\\"[link interno]\\\">carnê</a> é ideal para quem realiza vendas parceladas e também para quem trabalha com mensalidades. Você pode emitir carnês com até 12 parcelas e escolher a geração de PDF para impressão.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/carnes-introducao\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n  \\n  \\n  \\n  \\n  <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>MARKETPLACE GERENCIANET</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/marketplace-introducao\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/VM1LLjJTdmYST9qeDKeA_pie-chart%20(1).png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">O <a href=\\\"https://dev.gerencianet.com.br/docs/marketplace-introducao\\\" title=\\\"[link interno]\\\">Marketplace da Gerencianet</a> pode ser usado em situações em que o valor pago pelo comprador deve ser dividido entre dois ou mais vendedores.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/marketplace-introducao\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n              <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>INSTALE MÓDULOS PARA DIVERSAS PLATAFORMAS</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <img src=\\\"https://files.readme.io/VVj2EpBRRWvXeiSD9RSt_package.png\\\">\\n                            </div>\\n                            <p class=\\\"p30\\\">Possuímos módulos prontos para inúmeras plataformas: <a href=\\\"https://dev.gerencianet.com.br/docs/opencart\\\" title=\\\"[link interno]\\\">OpenCart</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/prestashop\\\" title=\\\"[link interno]\\\">PrestaShop</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/magento\\\" title=\\\"[link interno]\\\">Magento</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/wordpress-woocommerce\\\" title=\\\"[link interno]\\\">WordPress (WooCommerce)</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/joomla-virtuemart\\\" title=\\\"[link interno]\\\">Joomla (VirtueMart)</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/whmcs\\\" title=\\\"[link interno]\\\">WHMCS</a>, <a href=\\\"https://dev.gerencianet.com.br/docs/outros-modulos\\\" title=\\\"[link interno]\\\">dentre outros</a>.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/tipos-integracoes\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n  \\n  \\n  \\n   <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>SEJA NOTIFICADO QUANDO UMA TRANSAÇÃO FOR PAGA</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/aAz99dJvQhiuM0IAu71j_notification.png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">As <a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" title=\\\"[link interno]\\\">notificações</a> 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.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n              <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>EXEMPLOS DE INTEGRAÇÕES API GERENCIANET</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"http://www.gerencianet.com.br/exemplos-api/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><img src=\\\"https://files.readme.io/Y1ncJCUVQSGaloWpclD3_html-coding%20(1).png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Disponibilizamos <a href=\\\"http://www.gerencianet.com.br/exemplos-api/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\">exemplos prontos</a> 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 download.</p>\\n                          <p><a href=\\\"http://www.gerencianet.com.br/exemplos-api/\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n                      \\n                      \\n \\n  \\n  \\n  \\n  \\n  \\n  \\n  \\n                <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>VÍDEOS SOBRE INTEGRAÇÕES COM A API GERENCIANET</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\\\" title=\\\"[link interno]\\\"><img src=\\\"https://files.readme.io/70008ee-videos-integracoes.png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Assista os <a href=\\\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\\\" title=\\\"[link interno]\\\">vídeos explicativos</a> 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                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n                    <div class=\\\"col-lg-6 col-md-6 col-sm-6\\\">\\n                    <div class=\\\"panel panel-default\\\">\\n                        <div class=\\\"panel-heading\\\"><strong>QUER CONHECER MAIS DETALHES?</strong></div>\\n                        <div class=\\\"panel-body text-center\\\">\\n                            <div class=\\\"text-center top10\\\">\\n                                <a href=\\\"https://dev.gerencianet.com.br/docs/\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><img src=\\\"https://files.readme.io/VRMgSmhQ4eD2pA60ebLt_zoom-increasing-symbol.png\\\"></a>\\n                            </div>\\n                            <p class=\\\"p30\\\">Navegue pelas demais seções da nossa <a href=\\\"https://dev.gerencianet.com.br/docs/\\\" title=\\\"[link interno]\\\">documentação</a> para conhecer e explorar os recursos e possibilidades de integrações que a Gerencianet oferece.</p>\\n                          <p><a href=\\\"https://dev.gerencianet.com.br/docs/tipos-integracoes\\\" class=\\\"btn btn-primary\\\" role=\\\"button\\\">(+) Saiba Mais</a> </p>\\n\\n                        </div>\\n                    </div>\\n                </div>\\n            </div>\\n        </div>\"\n}\n[/block]","excerpt":"Você está em: *\"Visão Geral da API > Introdução\"*","slug":"introducao","type":"basic","title":"Introdução"}

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 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 registrado, 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] ## Bibliotecas <hr> [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, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-sdk-php", "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, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-sdk-node", "language": "javascript", "name": "NodeJS" }, { "code": "// Instalando via RubyGems (https://rubygems.org/gems/gerencianet):\n\n$ gem install gerencianet\n\n// Ou, se preferir, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-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, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-sdk-python", "language": "python" }, { "code": "// Instalando via NuGet (https://www.nuget.org/):\n\n$ nuget install Gerencianet.SDK\n \n// Ou, se preferir, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-sdk-dotnet", "language": "asp", "name": ".NET" }, { "code": "// Instalando via gradle:\ncompile 'br.com.gerencianet.gnsdk:gn-api-sdk-java:0.1.0'\n\n// Instalando via maven:\n<dependency>\n <groupId>br.com.gerencianet.gnsdk</groupId>\n <artifactId>gn-api-sdk-java</artifactId>\n <version>0.1.0</version>\n</dependency>\n// O Maven automaticamente instalará a SDK e todas as suas dependências.\n\n// Ou, se preferir, baixe diretamente pela nossa página do Github:\n// https://github.com/gerencianet/gn-api-sdk-java", "language": "java" } ] } [/block] ## Começando... <hr> [block:html] { "html": "<p>Antes de iniciar, <a href=\"https://gerencianet.com.br/#abrirconta\" target=\"_blank\" title=\"Cadastro ao nosso sistema, seja nosso cliente\">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 \"Client_Id\" e \"Client_Secret\": um 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\">?</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\">?</a>).</p>\n<p>Utilizando a API da Gerencianet, o integrador estará apto a gerar transações, definir a forma de pagamento (boleto ou cartão), gerar transações recorrentes, gerar carnês e receber notificações sempre que ocorrer uma alteração de status de uma transação.</p>\n<p>Para criar sua primeira aplicação, <a href=\"https://gerencianet.com.br/#login\" target=\"_blank\" title=\"Logue em sua conta Gerencianet\">logue</a> em sua conta Gerencianet, acesse o menu superior <em>\"<a href=\"http://docs.gerencianet.com.br\" target=\"_blank\" title=\"API\">API</a>\"</em>, depois clique em <em>\"Minhas Aplicações > Nova Aplicação\"</em> (<a href=\"http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png\" target=\"_blank\" title=\"Minhas Aplicações > Nova Aplicação\">?</a>) para criar sua primeira aplicação e ter acesso à tela de <abbr title=\"Ambiente de testes (sandbox) da Gerencianet\">Playground</abbr>. Essa tela mostra todos os <em>endpoints</em> disponibilizados pela API, ou seja, tudo que é possível realizar via integração.</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=\"Tabela integrações Gerencianet\">nesta tabela</a> essas informações para facilitar sua escolha. Por isso, escolha a melhor integração, de acordo com suas necessidades.</p>" } [/block] ## Conheça alguns dos recursos oferecidos pela API da Gerencianet <hr> [block:html] { "html": "\n\n<div class=\"col-lg-12 col-md-12 col-sm-12 text-center\">\n \n \n \n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>APRENDA INSTALAR A API DA GERENCIANET</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/instalacao-da-api\" title=\"[link interno]\"><img src=\"https://files.readme.io/mNlZ6eFCQDGBUBDH9rhd_settings%20(1).png\"></a>\n </div>\n <p class=\"p30\">Veja como é fácil <a href=\"https://dev.gerencianet.com.br/docs/instalacao-da-api\" title=\"[link interno]\">instalar nossa SDK</a> e integrar em seu site ou sistema. Disponibilizamos em seis linguagens: PHP, NodeJS, Ruby, Python, .NET e Java.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/instalacao-da-api\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>CRIAR TRANSAÇÃO E PAGAR COM BOLETO OU CARTÃO</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\" title=\"[link interno]\"><img src=\"https://files.readme.io/WEZDHxRDSW2HeOJD2Rgn_barcode-product.png\"></a>\n \t+\n \t<a href=\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\" title=\"[link interno]\"><img src=\"https://files.readme.io/m0QkHTIT62PT6wODA5hW_credit-cards-payment%20(1).png\"></a>\n </div>\n <p class=\"p30\">Receba de seus clientes sem burocracias bancárias. Todos os boletos e carnês gerados pela Gerencianet são registrados. Conheça mais sobre pagar com <a href=\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\" title=\"[link interno]\">boleto</a> e/ou <a href=\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\" title=\"[link interno]\">cartão</a>.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/pagar-boleto-introducao\" class=\"btn btn-primary\" role=\"button\">(+) Boleto</a> ou <a href=\"https://dev.gerencianet.com.br/docs/pagar-cartao-introducao\" class=\"btn btn-primary\" role=\"button\">(+) Cartão</a> </p>\n\n </div>\n </div>\n </div>\n \n \n \n \n \n \n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>COBRANÇAS RECORRENTES</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\" title=\"[link interno]\"><img src=\"https://files.readme.io/DBKxyjPTBGd12yURWfqT_cash.png\"></a>\n </div>\n <p class=\"p30\">Cobre seus clientes de <a href=\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\" title=\"[link interno]\">forma recorrente</a>. 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.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/assinaturas-introducao\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>GERE CARNÊS PARA SEUS CLIENTES</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/carnes-introducao\" title=\"[link interno]\"><img src=\"https://files.readme.io/rAud18Y7T0igh53WwL2n_barcode.png\"></a>\n </div>\n <p class=\"p30\">O <a href=\"https://dev.gerencianet.com.br/docs/carnes-introducao\" title=\"[link interno]\">carnê</a> é ideal para quem realiza vendas parceladas e também para quem trabalha com mensalidades. Você pode emitir carnês com até 12 parcelas e escolher a geração de PDF para impressão.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/carnes-introducao\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n \n \n \n \n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>MARKETPLACE GERENCIANET</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/marketplace-introducao\" title=\"[link interno]\"><img src=\"https://files.readme.io/VM1LLjJTdmYST9qeDKeA_pie-chart%20(1).png\"></a>\n </div>\n <p class=\"p30\">O <a href=\"https://dev.gerencianet.com.br/docs/marketplace-introducao\" title=\"[link interno]\">Marketplace da Gerencianet</a> pode ser usado em situações em que o valor pago pelo comprador deve ser dividido entre dois ou mais vendedores.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/marketplace-introducao\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>INSTALE MÓDULOS PARA DIVERSAS PLATAFORMAS</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <img src=\"https://files.readme.io/VVj2EpBRRWvXeiSD9RSt_package.png\">\n </div>\n <p class=\"p30\">Possuímos módulos prontos para inúmeras plataformas: <a href=\"https://dev.gerencianet.com.br/docs/opencart\" title=\"[link interno]\">OpenCart</a>, <a href=\"https://dev.gerencianet.com.br/docs/prestashop\" title=\"[link interno]\">PrestaShop</a>, <a href=\"https://dev.gerencianet.com.br/docs/magento\" title=\"[link interno]\">Magento</a>, <a href=\"https://dev.gerencianet.com.br/docs/wordpress-woocommerce\" title=\"[link interno]\">WordPress (WooCommerce)</a>, <a href=\"https://dev.gerencianet.com.br/docs/joomla-virtuemart\" title=\"[link interno]\">Joomla (VirtueMart)</a>, <a href=\"https://dev.gerencianet.com.br/docs/whmcs\" title=\"[link interno]\">WHMCS</a>, <a href=\"https://dev.gerencianet.com.br/docs/outros-modulos\" title=\"[link interno]\">dentre outros</a>.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n \n \n \n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>SEJA NOTIFICADO QUANDO UMA TRANSAÇÃO FOR PAGA</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" title=\"[link interno]\"><img src=\"https://files.readme.io/aAz99dJvQhiuM0IAu71j_notification.png\"></a>\n </div>\n <p class=\"p30\">As <a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" title=\"[link interno]\">notificações</a> 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.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>EXEMPLOS DE INTEGRAÇÕES API GERENCIANET</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"http://www.gerencianet.com.br/exemplos-api/\" target=\"_blank\" title=\"Link Externo\"><img src=\"https://files.readme.io/Y1ncJCUVQSGaloWpclD3_html-coding%20(1).png\"></a>\n </div>\n <p class=\"p30\">Disponibilizamos <a href=\"http://www.gerencianet.com.br/exemplos-api/\" target=\"_blank\" title=\"Link Externo\">exemplos prontos</a> 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 download.</p>\n <p><a href=\"http://www.gerencianet.com.br/exemplos-api/\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n \n \n \n \n \n \n \n \n \n \n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>VÍDEOS SOBRE INTEGRAÇÕES COM A API GERENCIANET</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\" title=\"[link interno]\"><img src=\"https://files.readme.io/70008ee-videos-integracoes.png\"></a>\n </div>\n <p class=\"p30\">Assista os <a href=\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\" title=\"[link interno]\">vídeos explicativos</a> 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 <p><a href=\"https://dev.gerencianet.com.br/docs/curso-online-gerencianet\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n <div class=\"col-lg-6 col-md-6 col-sm-6\">\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\"><strong>QUER CONHECER MAIS DETALHES?</strong></div>\n <div class=\"panel-body text-center\">\n <div class=\"text-center top10\">\n <a href=\"https://dev.gerencianet.com.br/docs/\" target=\"_blank\" title=\"Link Externo\"><img src=\"https://files.readme.io/VRMgSmhQ4eD2pA60ebLt_zoom-increasing-symbol.png\"></a>\n </div>\n <p class=\"p30\">Navegue pelas demais seções da nossa <a href=\"https://dev.gerencianet.com.br/docs/\" title=\"[link interno]\">documentação</a> para conhecer e explorar os recursos e possibilidades de integrações que a Gerencianet oferece.</p>\n <p><a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" class=\"btn btn-primary\" role=\"button\">(+) Saiba Mais</a> </p>\n\n </div>\n </div>\n </div>\n </div>\n </div>" } [/block]