{"_id":"5900ce94dbe7c30f000f99b0","version":{"_id":"575aeffae12cf20e002f306f","project":"575aeffae12cf20e002f306c","__v":30,"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","58c29df1258e5a1900b60478"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"2016","version_clean":"1.0.0","version":"1"},"__v":0,"user":"57601a13af3e090e00108059","project":"575aeffae12cf20e002f306c","parentDoc":null,"category":{"_id":"575aeffae12cf20e002f3070","version":"575aeffae12cf20e002f306f","__v":0,"project":"575aeffae12cf20e002f306c","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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-26T16:45:08.598Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":1,"body":"A seguir, confira a visão geral do fluxo de integração com a Gerencianet.\nLogo abaixo, você pode visualizar o [texto completo](https://dev.gerencianet.com.br/docs/visao-geral-fluxo-integracao#section-fluxo-de-integra-o) com explicações detalhadas.\n[block:html]\n{\n  \"html\": \"<iframe src=\\\"//my.visme.co/embed/8ryj6xev-guiageralgerencianet\\\" height=\\\"2217\\\" width=\\\"800\\\" style=\\\"border: 0px;\\\" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>\"\n}\n[/block]\n# Fluxo de Integração\n\nPronto para começar a usar a Gerencianet? Esta é uma pequena lista para ajudá-lo a iniciar suas operações com as nossas soluções de pagamento:\n\n\n## 1) Crie uma conta na Gerencianet\n\nSe você ainda não tem uma conta na Gerencianet, <a href=\"https://gerencianet.com.br/cadastro/\" target=\"_blank\">cadastre-se</a>. Ela será a sua identificação na Gerencianet e também o local que irá encontrar tudo para emitir cobranças para seus clientes. Atente-se ao prazo/taxas que você escolher ao abrir sua conta.\n\n\n## 2) Configure suas preferências\n\nApós criar sua conta Gerencianet, você poderá configurar os seguintes elementos:\n\n- Inserir sua logomarca;\n- Definir o texto para a fatura do cartão;\n- Configurar taxa de multa/juros;\n- Configurar nome fantasia;\n- Dentre outras opções.\n\n\n## 3) Escolha o tipo de integração\n\nJá sabe qual integração vai usar? Preparamos uma <a href=\"https://dev.gerencianet.com.br/docs/tipos-integracoes\" target=\"_blank\">tabela resumindo as integrações</a> e formas de uso disponíveis, acesse e escolha a que melhor atende suas necessidades.\n\nSe for utilizar um botão de pagamento ou botão de assinatura, você já pode terminar a leitura neste passo e seguir as informações que estão em sua conta Gerencianet assim que você gerar o botão desejado.\n\nCaso vá utilizar nossa API, veja os demais passos abaixo.\n\n\n## 4) Explore nosso ambiente de testes\n\nA Gerencianet oferece duas formas de utilizar o <a href=\"https://dev.gerencianet.com.br/docs/playground\" target=\"_blank\">ambiente de testes</a> (sandbox): (a) dentro de sua conta Gerencianet através do Playground ou (b) utilizando suas chaves *Client_Id* e *Client_Secret* de desenvolvimento:\n\n(a) O Playground é um ambiente isolado, semelhante ao ambiente de produção - é o local dentro de sua conta Gerencianet que você pode testar os recursos da API de forma online, sem precisar programar. É simples, veja:\n\n- Faça <a href=\"https://gerencianet.com.br/#login\" target=\"_blank\">login</a> em sua conta Gerencianet, acesse o menu *\"API\"*, depois *\"Minhas Aplicações > Nova aplicação\"* (<a href=\"http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png\" target=\"_blank\">?</a>), definindo um nome para a sua aplicação; e\n\n- A partir de agora, veja como usar nosso <a href=\"https://dev.gerencianet.com.br/docs/playground\" target=\"_blank\">Playground</a> e copie os códigos disponibilizados na seção \"<a href=\"https://dev.gerencianet.com.br/v1/docs/ambiente-de-testes\" target=\"_blank\">Ambiente de Testes</a>\" da documentação e explore o Playground.\n\n(b) Você também pode realizar testes de integração direto em sua aplicação/sistema antes de ir para ambiente de produção. Para isso, utilize suas chaves *Client_Id* e *Client_Secret* da aba \"Desenvolvimento\" (<a href=\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\" target=\"_blank\">?</a>).\n\nPara complementar, oferecemos vídeos ensinando mais sobre a API e o Playground:\n\n- Vídeo: <a href=\"https://www.youtube.com/watch?v=oy4aydoLUZA&index=5&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt\" target=\"_blank\">API Gerencianet</a>\n\n- Vídeo: <a href=\"https://www.youtube.com/watch?v=nKPb0rU8j4Q&index=6&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt\" target=\"_blank\">Métodos do Playground (ambiente de testes/sandbox da Gerencianet)</a>\n\n- Vídeo: <a href=\"https://www.youtube.com/watch?v=ylqJUpHqwfY&index=7&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt\" target=\"_blank\">Criando uma transação via Playground (ambiente de testes/sandbox da Gerencianet)</a>\n\n\n## 5) Confira as respostas da nossa API durante seus testes no Playground\n\nExplore a seção \"<a href=\"https://dev.gerencianet.com.br/docs/interpretando-erros-api\" target=\"_blank\">Histórico de Requisições</a>\" para visualizar todas as requisições realizadas por sua aplicação à nossa API. Assim, você vai aprender a interpretar os retornos da API Gerencianet e a corrigir possíveis erros de validação de dados ou outros similares.\n\nTodos os procedimento realizados no Playground (sandbox) serão listados na sub-aba \"Desenvolvimento\".\n\n<a href=\"https://www.youtube.com/watch?v=ad0SYoeGAZs\" target=\"_blank\">Assista o vídeo</a> em que ensinamos a utilizar o \"Histórico de Requisições\".\n\n\n## 6) Confira nossas SDKs disponíveis e escolha sua linguagem\n\nAtualmente, disponibilizamos SDKs nas seguintes linguagens: <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-php\" target=\"_blank\">PHP</a>, <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs\" target=\"_blank\">NodeJS</a>, <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby\" target=\"_blank\">Ruby</a>, <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-python\" target=\"_blank\">Python</a>, <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet\" target=\"_blank\">.NET</a>, <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-java\" target=\"_blank\">Java</a> e <a href=\"https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi\" target=\"_blank\">Delphi</a>.\n\nNão deixe de conferir a <a href=\"https://dev.gerencianet.com.br\" target=\"_blank\">documentação de nossa API</a> para visualizar os recursos (endpoints) disponíveis. Escolha os que desejar e inclua na integração de seu sistema.\n\n\n## 7) Qual a sua necessidade?\n\nPara ajudar a direcioná-lo, se a sua necessidade for:\n\n- Saber mais sobre o <a href=\"https://dev.gerencianet.com.br/docs/playground\" target=\"_blank\">ambiente de testes da Gerencianet</a>;\n\n- Gerar <a href=\"https://dev.gerencianet.com.br/docs/gerar-boleto\" target=\"_blank\">boleto bancário</a>;\n\n- Gerar pagamento via <a href=\"https://dev.gerencianet.com.br/docs/pagamento-cartao\" target=\"_blank\">cartão de crédito</a>;\n\n- Criar cobrança recorrente (<a href=\"https://dev.gerencianet.com.br/docs/criando-assinaturas\" target=\"_blank\">assinaturas</a>);\n\n- Emitir <a href=\"https://dev.gerencianet.com.br/docs/carnes-criando\" target=\"_blank\">carnês</a>;\n\n- Utilizar <a href=\"https://dev.gerencianet.com.br/docs/marketplace-introducao\" target=\"_blank\">marketplace</a>;\n\n- Criar <a href=\"https://dev.gerencianet.com.br/docs/link-pagamento-introducao\" target=\"_blank\">link de pagamento</a>;\n\n- Usar a Gerencianet nas plataformas <a href=\"https://dev.gerencianet.com.br/docs/wordpress-woocommerce\" target=\"_blank\">WooCommerce (WordPress)</a>, <a href=\"https://dev.gerencianet.com.br/docs/magento\" target=\"_blank\">Magento</a>, <a href=\"https://dev.gerencianet.com.br/docs/prestashop\" target=\"_blank\">PrestaShop</a>, <a href=\"https://dev.gerencianet.com.br/docs/opencart\" target=\"_blank\">OpenCart</a>, <a href=\"https://dev.gerencianet.com.br/docs/whmcs\" target=\"_blank\">WHMCS</a>, <a href=\"https://dev.gerencianet.com.br/docs/box-billing\" target=\"_blank\">BoxBilling</a> ou <a href=\"https://dev.gerencianet.com.br/docs/joomla-virtuemart\" target=\"_blank\">Joomla (VirtueMart)</a>;\n\n- Usar a Gerencianet em <a href=\"https://dev.gerencianet.com.br/docs/outros-modulos\" target=\"_blank\">outro sistema</a>.\n\n\n## 8) Terminou os testes e quer colocar no ambiente real de produção?\n\nApós certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam, é hora de alterar para o ambiente de produção (que é o \"ambiente real\", com transações \"reais\").\n\nEm sua aplicação/sistema, forneça o par de chaves Client_Id e Client_Secret da aba \"Produção\" e altere o valor do atributo <code>'sandbox'</code> de *true* para *false*. Só isso.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"DICA\",\n  \"body\": \"Não se esqueça de incluir o recurso de \\\"URL de notificação\\\" em sua integração, pois este recurso permite que seu sistema receba os callbacks das transações (por exemplo: quando um boleto for pago, cancelado, inadimplente, etc). Para mais detalhes, acesse a documentação sobre <a href=\\\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\\\" target=\\\"_blank\\\">notificações</a>.\"\n}\n[/block]\n## 9) Pronto\n\nNeste momento, você pode prosseguir com suas atividades normalmente. Caso queira conhecer mais sobre a API da Gerencianet, navegue pelas <a href=\"https://dev.gerencianet.com.br/docs\" target=\"_blank\">demais seções da nossa documentação</a> para conhecer e explorar os recursos e possibilidades de integrações oferecidos.\n\n\n### OBSERVAÇÕES:\n\n- Ao abrir a conta Gerencianet, inicie o processo de <a href=\"https://gerencianet.com.br/primeiros-passos/2-validacao-de-conta/\" target=\"_blank\">validação de sua conta</a>, que consiste no depósito de dois valores inferiores a R$1,00 que a Gerencianet irá depositar na conta bancária informada em seu cadastro. Geralmente esse depósito ocorre em até 3 (três) dias úteis.\n\n- Após validar sua conta Gerencianet, você poderá criar sua <a href=\"https://gerencianet.com.br/primeiros-passos/4-assinatura-eletronica/\" target=\"_blank\">assinatura eletrônica</a>, que é usada toda vez que você realiza uma operação de débito, como transferência, pagamento de conta, etc, e também para a alteração do número de celular e e-mail.\n\n- Tanto a validação de sua conta quanto a criação da assinatura eletrônica podem ser realizadas a qualquer momento, isto é, **você pode prosseguir com suas atividades de integração com a nossa API antes de validar sua conta e criar sua assinatura eletrônica.**","excerpt":"Você está em: *\"Visão Geral da API > Fluxo de Integração\"*","slug":"visao-geral-fluxo-integracao","type":"basic","title":"Fluxo de Integração"}

Fluxo de Integração

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

A seguir, confira a visão geral do fluxo de integração com a Gerencianet. Logo abaixo, você pode visualizar o [texto completo](https://dev.gerencianet.com.br/docs/visao-geral-fluxo-integracao#section-fluxo-de-integra-o) com explicações detalhadas. [block:html] { "html": "<iframe src=\"//my.visme.co/embed/8ryj6xev-guiageralgerencianet\" height=\"2217\" width=\"800\" style=\"border: 0px;\" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>" } [/block] # Fluxo de Integração Pronto para começar a usar a Gerencianet? Esta é uma pequena lista para ajudá-lo a iniciar suas operações com as nossas soluções de pagamento: ## 1) Crie uma conta na Gerencianet Se você ainda não tem uma conta na Gerencianet, <a href="https://gerencianet.com.br/cadastro/" target="_blank">cadastre-se</a>. Ela será a sua identificação na Gerencianet e também o local que irá encontrar tudo para emitir cobranças para seus clientes. Atente-se ao prazo/taxas que você escolher ao abrir sua conta. ## 2) Configure suas preferências Após criar sua conta Gerencianet, você poderá configurar os seguintes elementos: - Inserir sua logomarca; - Definir o texto para a fatura do cartão; - Configurar taxa de multa/juros; - Configurar nome fantasia; - Dentre outras opções. ## 3) Escolha o tipo de integração Já sabe qual integração vai usar? Preparamos uma <a href="https://dev.gerencianet.com.br/docs/tipos-integracoes" target="_blank">tabela resumindo as integrações</a> e formas de uso disponíveis, acesse e escolha a que melhor atende suas necessidades. Se for utilizar um botão de pagamento ou botão de assinatura, você já pode terminar a leitura neste passo e seguir as informações que estão em sua conta Gerencianet assim que você gerar o botão desejado. Caso vá utilizar nossa API, veja os demais passos abaixo. ## 4) Explore nosso ambiente de testes A Gerencianet oferece duas formas de utilizar o <a href="https://dev.gerencianet.com.br/docs/playground" target="_blank">ambiente de testes</a> (sandbox): (a) dentro de sua conta Gerencianet através do Playground ou (b) utilizando suas chaves *Client_Id* e *Client_Secret* de desenvolvimento: (a) O Playground é um ambiente isolado, semelhante ao ambiente de produção - é o local dentro de sua conta Gerencianet que você pode testar os recursos da API de forma online, sem precisar programar. É simples, veja: - Faça <a href="https://gerencianet.com.br/#login" target="_blank">login</a> em sua conta Gerencianet, acesse o menu *"API"*, depois *"Minhas Aplicações > Nova aplicação"* (<a href="http://image.prntscr.com/image/80b55642a21c4837b6fee00e7ed0758a.png" target="_blank">?</a>), definindo um nome para a sua aplicação; e - A partir de agora, veja como usar nosso <a href="https://dev.gerencianet.com.br/docs/playground" target="_blank">Playground</a> e copie os códigos disponibilizados na seção "<a href="https://dev.gerencianet.com.br/v1/docs/ambiente-de-testes" target="_blank">Ambiente de Testes</a>" da documentação e explore o Playground. (b) Você também pode realizar testes de integração direto em sua aplicação/sistema antes de ir para ambiente de produção. Para isso, utilize suas chaves *Client_Id* e *Client_Secret* da aba "Desenvolvimento" (<a href="http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png" target="_blank">?</a>). Para complementar, oferecemos vídeos ensinando mais sobre a API e o Playground: - Vídeo: <a href="https://www.youtube.com/watch?v=oy4aydoLUZA&index=5&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt" target="_blank">API Gerencianet</a> - Vídeo: <a href="https://www.youtube.com/watch?v=nKPb0rU8j4Q&index=6&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt" target="_blank">Métodos do Playground (ambiente de testes/sandbox da Gerencianet)</a> - Vídeo: <a href="https://www.youtube.com/watch?v=ylqJUpHqwfY&index=7&list=PLRqvcUTH2VsWKL03a0dUMaPobAKUSXyxt" target="_blank">Criando uma transação via Playground (ambiente de testes/sandbox da Gerencianet)</a> ## 5) Confira as respostas da nossa API durante seus testes no Playground Explore a seção "<a href="https://dev.gerencianet.com.br/docs/interpretando-erros-api" target="_blank">Histórico de Requisições</a>" para visualizar todas as requisições realizadas por sua aplicação à nossa API. Assim, você vai aprender a interpretar os retornos da API Gerencianet e a corrigir possíveis erros de validação de dados ou outros similares. Todos os procedimento realizados no Playground (sandbox) serão listados na sub-aba "Desenvolvimento". <a href="https://www.youtube.com/watch?v=ad0SYoeGAZs" target="_blank">Assista o vídeo</a> em que ensinamos a utilizar o "Histórico de Requisições". ## 6) Confira nossas SDKs disponíveis e escolha sua linguagem Atualmente, disponibilizamos SDKs nas seguintes linguagens: <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-php" target="_blank">PHP</a>, <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs" target="_blank">NodeJS</a>, <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby" target="_blank">Ruby</a>, <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-python" target="_blank">Python</a>, <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet" target="_blank">.NET</a>, <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-java" target="_blank">Java</a> e <a href="https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi" target="_blank">Delphi</a>. Não deixe de conferir a <a href="https://dev.gerencianet.com.br" target="_blank">documentação de nossa API</a> para visualizar os recursos (endpoints) disponíveis. Escolha os que desejar e inclua na integração de seu sistema. ## 7) Qual a sua necessidade? Para ajudar a direcioná-lo, se a sua necessidade for: - Saber mais sobre o <a href="https://dev.gerencianet.com.br/docs/playground" target="_blank">ambiente de testes da Gerencianet</a>; - Gerar <a href="https://dev.gerencianet.com.br/docs/gerar-boleto" target="_blank">boleto bancário</a>; - Gerar pagamento via <a href="https://dev.gerencianet.com.br/docs/pagamento-cartao" target="_blank">cartão de crédito</a>; - Criar cobrança recorrente (<a href="https://dev.gerencianet.com.br/docs/criando-assinaturas" target="_blank">assinaturas</a>); - Emitir <a href="https://dev.gerencianet.com.br/docs/carnes-criando" target="_blank">carnês</a>; - Utilizar <a href="https://dev.gerencianet.com.br/docs/marketplace-introducao" target="_blank">marketplace</a>; - Criar <a href="https://dev.gerencianet.com.br/docs/link-pagamento-introducao" target="_blank">link de pagamento</a>; - Usar a Gerencianet nas plataformas <a href="https://dev.gerencianet.com.br/docs/wordpress-woocommerce" target="_blank">WooCommerce (WordPress)</a>, <a href="https://dev.gerencianet.com.br/docs/magento" target="_blank">Magento</a>, <a href="https://dev.gerencianet.com.br/docs/prestashop" target="_blank">PrestaShop</a>, <a href="https://dev.gerencianet.com.br/docs/opencart" target="_blank">OpenCart</a>, <a href="https://dev.gerencianet.com.br/docs/whmcs" target="_blank">WHMCS</a>, <a href="https://dev.gerencianet.com.br/docs/box-billing" target="_blank">BoxBilling</a> ou <a href="https://dev.gerencianet.com.br/docs/joomla-virtuemart" target="_blank">Joomla (VirtueMart)</a>; - Usar a Gerencianet em <a href="https://dev.gerencianet.com.br/docs/outros-modulos" target="_blank">outro sistema</a>. ## 8) Terminou os testes e quer colocar no ambiente real de produção? Após certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam, é hora de alterar para o ambiente de produção (que é o "ambiente real", com transações "reais"). Em sua aplicação/sistema, forneça o par de chaves Client_Id e Client_Secret da aba "Produção" e altere o valor do atributo <code>'sandbox'</code> de *true* para *false*. Só isso. [block:callout] { "type": "info", "title": "DICA", "body": "Não se esqueça de incluir o recurso de \"URL de notificação\" em sua integração, pois este recurso permite que seu sistema receba os callbacks das transações (por exemplo: quando um boleto for pago, cancelado, inadimplente, etc). Para mais detalhes, acesse a documentação sobre <a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\" target=\"_blank\">notificações</a>." } [/block] ## 9) Pronto Neste momento, você pode prosseguir com suas atividades normalmente. Caso queira conhecer mais sobre a API da Gerencianet, navegue pelas <a href="https://dev.gerencianet.com.br/docs" target="_blank">demais seções da nossa documentação</a> para conhecer e explorar os recursos e possibilidades de integrações oferecidos. ### OBSERVAÇÕES: - Ao abrir a conta Gerencianet, inicie o processo de <a href="https://gerencianet.com.br/primeiros-passos/2-validacao-de-conta/" target="_blank">validação de sua conta</a>, que consiste no depósito de dois valores inferiores a R$1,00 que a Gerencianet irá depositar na conta bancária informada em seu cadastro. Geralmente esse depósito ocorre em até 3 (três) dias úteis. - Após validar sua conta Gerencianet, você poderá criar sua <a href="https://gerencianet.com.br/primeiros-passos/4-assinatura-eletronica/" target="_blank">assinatura eletrônica</a>, que é usada toda vez que você realiza uma operação de débito, como transferência, pagamento de conta, etc, e também para a alteração do número de celular e e-mail. - Tanto a validação de sua conta quanto a criação da assinatura eletrônica podem ser realizadas a qualquer momento, isto é, **você pode prosseguir com suas atividades de integração com a nossa API antes de validar sua conta e criar sua assinatura eletrônica.**