{"__v":1,"_id":"5797be486b0a1b19006decca","category":{"__v":0,"_id":"57604518b82256240055c722","project":"575aeffae12cf20e002f306c","version":"575aeffae12cf20e002f306f","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-06-14T17:55:36.688Z","from_sync":false,"order":18,"slug":"dúvidas-fale-conosco","title":"Dúvidas?"},"parentDoc":null,"project":"575aeffae12cf20e002f306c","user":"57601a13af3e090e00108059","version":{"__v":30,"_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","58c29df1258e5a1900b60478"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"2016","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-26T19:47:20.192Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"## Ambiente de Desenvolvimento\n\nEste é o local que a Gerencianet disponibiliza ao integrador para testar sua integração. Este ambiente também é conhecido por \"Playground\" ou \"sandbox\". Todas as transações geradas neste ambiente são \"fictícias\", porém, possui o mesmo fluxo/mecanismo do ambiente \"real\". Quer testar algo? Utilize este ambiente.\n\nTerminou os testes e quer colocar no ambiente real de produção? Você deve alterar as seguintes informações em sua integração:\n\n- Fornecer o \"Client_Id\" e o \"Client_Secret\" da aba \"Produção\" (<a href=\"http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png\" target=\"_blank\">?</a>); e\n- Definir a variável \"sandbox\" com o valor <code>false</code>\n\n<hr>\n\n## Ambiente de Produção\n\nEste é o ambiente \"real\" que sua aplicação deverá estar para gerar cobranças (ou \"transações\") \"reais\". É importante que primeiro você teste tudo que precisar no ambiente de desenvolvimento, e somente após conferir que sua integração está funcionando adequadamente é que você deve migrar para o ambiente de produção.\n\nSua aplicação está em produção e você precisa testar algo em sua integração no ambiente de desenvolvimento? Você deve alterar as seguintes informações em sua integração:\n\n- Fornecer o \"Client_Id\" e o \"Client_Secret\" da aba \"Desenvolvimento\" (<a href=\"http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png\" target=\"_blank\">?</a>); e\n- Definir a variável \"sandbox\" com o valor <code>true</code>\n\n<hr>\n\n## API\n\nUma API, de *Application Programming Interface* (em português: *Interface de Programação de Aplicativos*) é um conjunto de rotinas, protocolos e ferramentas para construir aplicações.\n\nA API da Gerencianet foi desenvolvida para ser flexível e permitir que você coloque suas ideias em prática rapidamente. [Nesta tabela](https://dev.gerencianet.com.br/docs/tipos-integracoes) você confere as diversas formas que possui para cobrar seu cliente, inclusive via integração com a nossa API.\n\n<hr>\n\n\n## Client ID e Client Secret\n\nEstão relacionados às chaves para autenticar com o servidor de autorização. Um integrador pode criar inúmeras aplicações em sua conta Gerencianet, e cada aplicação criada possui um par de chaves, tanto para ambiente de desenvolvimento quanto de produção.\n\nDessa forma, você consegue, por exemplo, informar seu <code>Client_Id</code> e <code>Client_Secret</code> de *\"Desenvolvimento\"* e testar sua aplicação antes de colocá-la em ambiente de produção e, assim, você consegue certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam.\n\n\n<hr>\n\n\n## Endpoint\n\nUm *endpoint* de um web service é a URL onde seu serviço pode ser acessado por uma aplicação cliente. Em outras palavras, imagine o seguinte:\n\nUma URL é o endereço que deve ser acessado. A URL que você está usando agora começa com dev.gerencianet.com.br/**docs**/. Depois de \"**docs**\", vem um outro conjunto de caracteres que especifica exatamente qual recurso (ou no caso, qual página) você quer acessar. Nesse momento, o recurso que você está acessando é o “glossario”.\n\nEm uma API, o conceito é o mesmo. Você sempre tem endereço que navega pelos diferentes recursos que estão sendo expostos. Esse endereço é conhecido como o *endpoint* em que os recursos estarão disponíveis.\n\n<hr>\n\n## Método\n\nO método é o *verbo* que você usará para interagir com o recurso. Normalmente, você tem 4 opções para interagir:\n\n- GET, que *pede* ao servidor o recurso;\n- POST, que *pede* ao servidor que crie um recurso novo;\n- DELETE, que *pede* ao servidor que apague um recurso;\n- PUT, que *pede* ao servidor a atualização ou edição de um recurso.\n\nCaso queira conhecer mais a respeito, veja <a href=\"https://dev.gerencianet.com.br/docs/playground#section-get-post-put-e-delete\">neste link</a>.\n\n<hr>\n\n\n## payee_code\n\nEsse é o identificador da conta Gerencianet. Cada conta possui um identificador único. Independente se o integrador possui uma ou dezenas de aplicações criadas, o identificador da conta é único.\n\nVeja <a href=\"http://image.prntscr.com/image/cabe13e1e5b64449b942cf31139150ba.png\" target=\"_blank\">onde localizar</a> o seu identificador.\n\n\n<hr>\n\n\n## Payment Token\n\nNosso processo de pagamento de cartão de crédito é realizado em 2 etapas: a primeira envia dados do cartão e obtém um <code>payment_token</code>. A segunda envia o restante das informações da cobrança e o <code>payment_token</code> obtido.\n\nUma conta Gerencianet não possui um <code>payment_token</code> - um <code>payment_token</code> diferente é criado para cada cobrança gerada por cartão de crédito. Ele representa os dados do cartão do pagador e é obtido pela função <code>getPaymentToken</code>. Além disso, cabe frisar que o <code>payment_token</code> pode ser utilizado uma única vez, portanto, não é possível utilizá-lo para cobrar de forma recorrente.\n\nO <code>payment_token</code> **só é necessário quando o pagamento é por cartão de crédito**. Para obtê-lo, deve ser colado um código Javascript de nossa biblioteca em sua página de pagamentos.\n\nObtenha seu código JavaScript, específico de sua conta Gerencianet, através <a href=\"https://dev.gerencianet.com.br/docs/pagamento-cartao\" target=\"_blank\">deste link</a>.\n\n\n<hr>\n\n\n## Playground\n\nO Playground é o ambiente de testes (sandbox) da Gerencianet. Trata-se de um local no qual o integrador, independente da operação a ser realizada, pode utilizar para conhecer o mecanismo e o fluxo de pagamento em um ambiente 100% de teste e descomplicado. Ou seja, por oferecer uma paridade com os recursos suportados pela API no ambiente de produção, é possível efetuar testes de integração antes de ir para produção, podendo assim fazer uma experiência com nossa API sem fazer alterações em sua conta Gerencianet.\n\nConheça mais sobre o Playground <a href=\"https://dev.gerencianet.com.br/docs/playground\">neste link</a>.\n\n\n<hr>\n\n## Token de Notificação\n\nTrata-se do token que é enviado pela Gerencianet via POST para a URL de notificação cadastrada pelo integrador sempre que uma cobrança (também chamado de transação) sofrer alteração de status (de *\"aguardando\"* para *\"paga\"*, por exemplo). Para verificar quais foram as alterações, é preciso consultá-las, utilizando o token de notificação enviado.\n\nA qualquer momento que o integrador consultar esse token de notificação, irá obter as informações mais atuais da transação, todas ordenadas de acordo com os acontecimentos. Toda alteração em status gera uma notificação. Cada cobrança possui um token de notificação que será o mesmo durante todo o \"ciclo de alterações\" dessa cobrança.\n\nO POST será uma informação semelhante a esta:\n\n<code>$_POST['notification'] = \"435e1d24-b761-4afc-a5a8-ebc50b5ui78e\";</code>\n\nCom esse token, o sistema deve utilizar a função <code>getNotification(:token)</code> para obter todas as alterações de status da transação.\n\nConheça mais sobre notificações <a href=\"https://dev.gerencianet.com.br/docs/notificacoes-recebendo\">neste link</a>.\n\n\n\n<hr>","excerpt":"Você está em: *\"Dúvidas > Glossário\"*","slug":"glossario","type":"basic","title":"Glossário"}

Glossário

Você está em: *"Dúvidas > Glossário"*

## Ambiente de Desenvolvimento Este é o local que a Gerencianet disponibiliza ao integrador para testar sua integração. Este ambiente também é conhecido por "Playground" ou "sandbox". Todas as transações geradas neste ambiente são "fictícias", porém, possui o mesmo fluxo/mecanismo do ambiente "real". Quer testar algo? Utilize este ambiente. Terminou os testes e quer colocar no ambiente real de produção? Você deve alterar as seguintes informações em sua integração: - Fornecer o "Client_Id" e o "Client_Secret" da aba "Produção" (<a href="http://image.prntscr.com/image/7dc272063bb74dccba91739701a0478b.png" target="_blank">?</a>); e - Definir a variável "sandbox" com o valor <code>false</code> <hr> ## Ambiente de Produção Este é o ambiente "real" que sua aplicação deverá estar para gerar cobranças (ou "transações") "reais". É importante que primeiro você teste tudo que precisar no ambiente de desenvolvimento, e somente após conferir que sua integração está funcionando adequadamente é que você deve migrar para o ambiente de produção. Sua aplicação está em produção e você precisa testar algo em sua integração no ambiente de desenvolvimento? Você deve alterar as seguintes informações em sua integração: - Fornecer o "Client_Id" e o "Client_Secret" da aba "Desenvolvimento" (<a href="http://image.prntscr.com/image/447be4bc64644a35bcf5eaecd1125f5d.png" target="_blank">?</a>); e - Definir a variável "sandbox" com o valor <code>true</code> <hr> ## API Uma API, de *Application Programming Interface* (em português: *Interface de Programação de Aplicativos*) é um conjunto de rotinas, protocolos e ferramentas para construir aplicações. A API da Gerencianet foi desenvolvida para ser flexível e permitir que você coloque suas ideias em prática rapidamente. [Nesta tabela](https://dev.gerencianet.com.br/docs/tipos-integracoes) você confere as diversas formas que possui para cobrar seu cliente, inclusive via integração com a nossa API. <hr> ## Client ID e Client Secret Estão relacionados às chaves para autenticar com o servidor de autorização. Um integrador pode criar inúmeras aplicações em sua conta Gerencianet, e cada aplicação criada possui um par de chaves, tanto para ambiente de desenvolvimento quanto de produção. Dessa forma, você consegue, por exemplo, informar seu <code>Client_Id</code> e <code>Client_Secret</code> de *"Desenvolvimento"* e testar sua aplicação antes de colocá-la em ambiente de produção e, assim, você consegue certificar-se que sua implementação está correta e suas integrações estão comunicando da forma como deveriam. <hr> ## Endpoint Um *endpoint* de um web service é a URL onde seu serviço pode ser acessado por uma aplicação cliente. Em outras palavras, imagine o seguinte: Uma URL é o endereço que deve ser acessado. A URL que você está usando agora começa com dev.gerencianet.com.br/**docs**/. Depois de "**docs**", vem um outro conjunto de caracteres que especifica exatamente qual recurso (ou no caso, qual página) você quer acessar. Nesse momento, o recurso que você está acessando é o “glossario”. Em uma API, o conceito é o mesmo. Você sempre tem endereço que navega pelos diferentes recursos que estão sendo expostos. Esse endereço é conhecido como o *endpoint* em que os recursos estarão disponíveis. <hr> ## Método O método é o *verbo* que você usará para interagir com o recurso. Normalmente, você tem 4 opções para interagir: - GET, que *pede* ao servidor o recurso; - POST, que *pede* ao servidor que crie um recurso novo; - DELETE, que *pede* ao servidor que apague um recurso; - PUT, que *pede* ao servidor a atualização ou edição de um recurso. Caso queira conhecer mais a respeito, veja <a href="https://dev.gerencianet.com.br/docs/playground#section-get-post-put-e-delete">neste link</a>. <hr> ## payee_code Esse é o identificador da conta Gerencianet. Cada conta possui um identificador único. Independente se o integrador possui uma ou dezenas de aplicações criadas, o identificador da conta é único. Veja <a href="http://image.prntscr.com/image/cabe13e1e5b64449b942cf31139150ba.png" target="_blank">onde localizar</a> o seu identificador. <hr> ## Payment Token Nosso processo de pagamento de cartão de crédito é realizado em 2 etapas: a primeira envia dados do cartão e obtém um <code>payment_token</code>. A segunda envia o restante das informações da cobrança e o <code>payment_token</code> obtido. Uma conta Gerencianet não possui um <code>payment_token</code> - um <code>payment_token</code> diferente é criado para cada cobrança gerada por cartão de crédito. Ele representa os dados do cartão do pagador e é obtido pela função <code>getPaymentToken</code>. Além disso, cabe frisar que o <code>payment_token</code> pode ser utilizado uma única vez, portanto, não é possível utilizá-lo para cobrar de forma recorrente. O <code>payment_token</code> **só é necessário quando o pagamento é por cartão de crédito**. Para obtê-lo, deve ser colado um código Javascript de nossa biblioteca em sua página de pagamentos. Obtenha seu código JavaScript, específico de sua conta Gerencianet, através <a href="https://dev.gerencianet.com.br/docs/pagamento-cartao" target="_blank">deste link</a>. <hr> ## Playground O Playground é o ambiente de testes (sandbox) da Gerencianet. Trata-se de um local no qual o integrador, independente da operação a ser realizada, pode utilizar para conhecer o mecanismo e o fluxo de pagamento em um ambiente 100% de teste e descomplicado. Ou seja, por oferecer uma paridade com os recursos suportados pela API no ambiente de produção, é possível efetuar testes de integração antes de ir para produção, podendo assim fazer uma experiência com nossa API sem fazer alterações em sua conta Gerencianet. Conheça mais sobre o Playground <a href="https://dev.gerencianet.com.br/docs/playground">neste link</a>. <hr> ## Token de Notificação Trata-se do token que é enviado pela Gerencianet via POST para a URL de notificação cadastrada pelo integrador sempre que uma cobrança (também chamado de transação) sofrer alteração de status (de *"aguardando"* para *"paga"*, por exemplo). Para verificar quais foram as alterações, é preciso consultá-las, utilizando o token de notificação enviado. A qualquer momento que o integrador consultar esse token de notificação, irá obter as informações mais atuais da transação, todas ordenadas de acordo com os acontecimentos. Toda alteração em status gera uma notificação. Cada cobrança possui um token de notificação que será o mesmo durante todo o "ciclo de alterações" dessa cobrança. O POST será uma informação semelhante a esta: <code>$_POST['notification'] = "435e1d24-b761-4afc-a5a8-ebc50b5ui78e";</code> Com esse token, o sistema deve utilizar a função <code>getNotification(:token)</code> para obter todas as alterações de status da transação. Conheça mais sobre notificações <a href="https://dev.gerencianet.com.br/docs/notificacoes-recebendo">neste link</a>. <hr>