{"_id":"5cffe58091e4fe00512bdef4","project":"575aeffae12cf20e002f306c","version":{"_id":"575aeffae12cf20e002f306f","project":"575aeffae12cf20e002f306c","__v":33,"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","5a7c4127490e52002a7f643c","5ce43ecb9e6a78002aae5c66","5ce7de70923530005cbe627a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"2016","version_clean":"1.0.0","version":"1"},"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":2,"slug":"documentation","title":"Visão Geral da API"},"user":"5cd2cff826c124005d237439","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-06-11T17:31:44.506Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":5,"body":"Nesta página trataremos os limites de uso da API Gerencianet, tais limites podem ser separados em duas vertentes básicas, limite de emissões e limite de consumo, ambos serão abordados de maneira detalhada a seguir.\n\n# Limites de emissão\n\nAtualmente, o limite de emissões para um mesmo cliente é 13 (treze) diárias e/ou 30 (trinta) mensais. Assim pode-se questionar: o que representa para a Gerencianet um cliente? A API irá interpretar as emissões como sendo para um mesmo cliente quando um ou mais dos seguintes dados forem iguais:\n\n* E-mail\n* CPF\n* Telefone\n\nCabe frisar, ainda, que cada requisição realizada com sucesso equivale a 1 consumo (emissão). No caso de carnês (rota <code>*POST /carnet*</code>), mesmo se for criado um carnê de 12 parcelas, houve apenas 1 consumo (emissão) da rota <code>*POST /carnet*</code>, e não 12 consumos. Temos algumas situações em que o cliente, ao invés de gerar 1 carnê com 12 parcelas, age criando 12 (ou mais) boletos de mesmo valor, com diferença de vencimento mensal. Se esses clientes consumissem 1 requisição de transação por carnê, ao invés de 12 requisições de transações por boleto, eles poderiam ter o mesmo resultado, e economizar consumos.\n\n# Limites de consumo\n\nOs limites de consumo se referem ao consumo das rotas (*endpoints*) da API, tais limites se aplicam a cada aplicação individualmente, ou seja, caso você possua uma conta com 2 aplicações, cada uma terá seus limites independentes, sendo estes reiniciados (zerados) diariamente (intervalo de 24 horas). \nÉ importante lembrar que é disparado um aviso quando se atinge 80% de consumo do limite de um *endpoint* para o *email* cadastrado no perfil de sua conta Gerencianet.\nEm casos onde se atinge o número máximo de requisições para um *endpoint* um aviso de bloqueio será disparado para o *email* cadastrado no perfil de sua conta Gerencianet, e tal *endpoit* só será liberado para uso após o desbloqueio automático.\nA seguir descreveremos todos os *endpoints* disponíveis para consumo e seus respectivos limites.\n\n\n# Transações\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint (Rota base)\",\n    \"h-1\": \"Limite de requisições\",\n    \"0-0\": \"**POST ** <code>/v1/charge</code>\",\n    \"1-0\": \"**GET ** <code>/v1/charge/:id</code>\",\n    \"2-0\": \"**PUT ** <code>/v1/charge/:id/metadata</code>\",\n    \"3-0\": \"**PUT ** <code>/v1/charge/:id/billet</code>\",\n    \"4-0\": \"**PUT ** <code>/v1/charge/:id/cancel</code>\",\n    \"5-0\": \"**POST ** <code>/v1/charge/:id/pay</code>\",\n    \"6-0\": \"**POST ** <code>/v1/charge/:id/billet/resend</code>\",\n    \"7-0\": \"**POST ** <code>/v1/charge/:id/history</code>\",\n    \"8-0\": \"**POST ** <code>/v1/charge/:id/link</code>\",\n    \"9-0\": \"**PUT ** <code>/v1/charge/:id/link</code>\",\n    \"10-0\": \"**POST ** <code>/v1/charge/:id/balance-sheet</code>\",\n    \"11-0\": \"**PUT ** <code>/v1/charge/:id/settle</code>\",\n    \"0-1\": \"7.500\",\n    \"1-1\": \"7.500\",\n    \"2-1\": \"7.500\",\n    \"3-1\": \"7.500\",\n    \"4-1\": \"7.500\",\n    \"5-1\": \"7.500\",\n    \"6-1\": \"7.500\",\n    \"7-1\": \"7.500\",\n    \"8-1\": \"7.500\",\n    \"9-1\": \"7.500\",\n    \"10-1\": \"7.500\",\n    \"11-1\": \"7.500\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\n# Carnês\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint (Rota base)\",\n    \"h-1\": \"Limite de requisições\",\n    \"0-0\": \"**POST**  <code>/v1/carnet</code>\",\n    \"1-0\": \"**GET**  <code>/v1/carnet/:id/</code>\",\n    \"2-0\": \"**PUT**  <code>/v1/carnet/:id/metadata</code>\",\n    \"3-0\": \"**PUT**  <code>/v1/carnet/:id/parcel/:parcel</code>\",\n    \"4-0\": \"**PUT**  <code>/v1/carnet/:id/cancel</code>\",\n    \"5-0\": \"**PUT**  <code>/v1/carnet/:id/parcel/:parcel/cancel</code>\",\n    \"6-0\": \"**POST**  <code>/v1/carnet/:id/resend</code>\",\n    \"7-0\": \"**POST**  <code>/v1/carnet/:id/parcel/:parcel/resend</code>\",\n    \"8-0\": \"**POST**  <code>/v1/carnet/:id/history</code>\",\n    \"9-0\": \"**PUT**  <code>/v1/carnet/:id/parcel/:parcel/settle</code>\",\n    \"10-0\": \"**PUT**  <code>/v1/carnet/:id/settle</code>\",\n    \"0-1\": \"7.500\",\n    \"1-1\": \"7.500\",\n    \"2-1\": \"7.500\",\n    \"3-1\": \"7.500\",\n    \"4-1\": \"7.500\",\n    \"5-1\": \"7.500\",\n    \"6-1\": \"7.500\",\n    \"7-1\": \"7.500\",\n    \"8-1\": \"7.500\",\n    \"9-1\": \"7.500\",\n    \"10-1\": \"7.500\"\n  },\n  \"cols\": 2,\n  \"rows\": 11\n}\n[/block]\n# Notificações\n\nEste *endpoint* é de uso exclusivo da API Gerencianet sendo utilizado na comunicação com o sistema integrado para atualização de status das transações.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint (Rota base)\",\n    \"h-1\": \"Limite de requisições\",\n    \"0-0\": \"**GET ** <code>/v1/notification/:token</code>\",\n    \"0-1\": \"15.000\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n# Assinaturas\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint (Rota base)\",\n    \"h-1\": \"Limite de requisições\",\n    \"0-0\": \"**POST**  <code>/v1/plan</code>\",\n    \"1-0\": \"**GET**  <code>/v1/plans</code>\",\n    \"2-0\": \"**PUT**  <code>/v1/plan/:id</code>\",\n    \"3-0\": \"**DELETE**  <code>/v1/plan/:id</code>\",\n    \"4-0\": \"**POST**  <code>/v1/plan/:id/subscription</code>\",\n    \"0-1\": \"7.500\",\n    \"1-1\": \"7.500\",\n    \"2-1\": \"7.500\",\n    \"3-1\": \"7.500\",\n    \"4-1\": \"7.500\",\n    \"5-0\": \"**GET**  <code>/v1/subscription/:id</code>\",\n    \"6-0\": \"**PUT**  <code>/v1/subscription/:id/cancel</code>\",\n    \"7-0\": \"**PUT**  <code>/v1/subscription/:id/metadata</code>\",\n    \"8-0\": \"**POST**  <code>/v1/subscription/:id/pay</code>\",\n    \"9-0\": \"**POST**  <code>/v1/subscription/:id/history</code>\",\n    \"5-1\": \"7.500\",\n    \"6-1\": \"7.500\",\n    \"7-1\": \"7.500\",\n    \"8-1\": \"7.500\",\n    \"9-1\": \"7.500\"\n  },\n  \"cols\": 2,\n  \"rows\": 10\n}\n[/block]\n# Outros\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Endpoint (Rota base)\",\n    \"h-1\": \"Limite de requisições\",\n    \"0-0\": \"**GET**  <code>/v1/installments</code>\",\n    \"0-1\": \"7.500\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"Você está em: *\"Visão Geral da API > Limites de Consumo\"*","slug":"limites-de-consumo","type":"basic","title":"Limites de Consumo"}

Limites de Consumo

Você está em: *"Visão Geral da API > Limites de Consumo"*

Nesta página trataremos os limites de uso da API Gerencianet, tais limites podem ser separados em duas vertentes básicas, limite de emissões e limite de consumo, ambos serão abordados de maneira detalhada a seguir. # Limites de emissão Atualmente, o limite de emissões para um mesmo cliente é 13 (treze) diárias e/ou 30 (trinta) mensais. Assim pode-se questionar: o que representa para a Gerencianet um cliente? A API irá interpretar as emissões como sendo para um mesmo cliente quando um ou mais dos seguintes dados forem iguais: * E-mail * CPF * Telefone Cabe frisar, ainda, que cada requisição realizada com sucesso equivale a 1 consumo (emissão). No caso de carnês (rota <code>*POST /carnet*</code>), mesmo se for criado um carnê de 12 parcelas, houve apenas 1 consumo (emissão) da rota <code>*POST /carnet*</code>, e não 12 consumos. Temos algumas situações em que o cliente, ao invés de gerar 1 carnê com 12 parcelas, age criando 12 (ou mais) boletos de mesmo valor, com diferença de vencimento mensal. Se esses clientes consumissem 1 requisição de transação por carnê, ao invés de 12 requisições de transações por boleto, eles poderiam ter o mesmo resultado, e economizar consumos. # Limites de consumo Os limites de consumo se referem ao consumo das rotas (*endpoints*) da API, tais limites se aplicam a cada aplicação individualmente, ou seja, caso você possua uma conta com 2 aplicações, cada uma terá seus limites independentes, sendo estes reiniciados (zerados) diariamente (intervalo de 24 horas). É importante lembrar que é disparado um aviso quando se atinge 80% de consumo do limite de um *endpoint* para o *email* cadastrado no perfil de sua conta Gerencianet. Em casos onde se atinge o número máximo de requisições para um *endpoint* um aviso de bloqueio será disparado para o *email* cadastrado no perfil de sua conta Gerencianet, e tal *endpoit* só será liberado para uso após o desbloqueio automático. A seguir descreveremos todos os *endpoints* disponíveis para consumo e seus respectivos limites. # Transações [block:parameters] { "data": { "h-0": "Endpoint (Rota base)", "h-1": "Limite de requisições", "0-0": "**POST ** <code>/v1/charge</code>", "1-0": "**GET ** <code>/v1/charge/:id</code>", "2-0": "**PUT ** <code>/v1/charge/:id/metadata</code>", "3-0": "**PUT ** <code>/v1/charge/:id/billet</code>", "4-0": "**PUT ** <code>/v1/charge/:id/cancel</code>", "5-0": "**POST ** <code>/v1/charge/:id/pay</code>", "6-0": "**POST ** <code>/v1/charge/:id/billet/resend</code>", "7-0": "**POST ** <code>/v1/charge/:id/history</code>", "8-0": "**POST ** <code>/v1/charge/:id/link</code>", "9-0": "**PUT ** <code>/v1/charge/:id/link</code>", "10-0": "**POST ** <code>/v1/charge/:id/balance-sheet</code>", "11-0": "**PUT ** <code>/v1/charge/:id/settle</code>", "0-1": "7.500", "1-1": "7.500", "2-1": "7.500", "3-1": "7.500", "4-1": "7.500", "5-1": "7.500", "6-1": "7.500", "7-1": "7.500", "8-1": "7.500", "9-1": "7.500", "10-1": "7.500", "11-1": "7.500" }, "cols": 2, "rows": 12 } [/block] # Carnês [block:parameters] { "data": { "h-0": "Endpoint (Rota base)", "h-1": "Limite de requisições", "0-0": "**POST** <code>/v1/carnet</code>", "1-0": "**GET** <code>/v1/carnet/:id/</code>", "2-0": "**PUT** <code>/v1/carnet/:id/metadata</code>", "3-0": "**PUT** <code>/v1/carnet/:id/parcel/:parcel</code>", "4-0": "**PUT** <code>/v1/carnet/:id/cancel</code>", "5-0": "**PUT** <code>/v1/carnet/:id/parcel/:parcel/cancel</code>", "6-0": "**POST** <code>/v1/carnet/:id/resend</code>", "7-0": "**POST** <code>/v1/carnet/:id/parcel/:parcel/resend</code>", "8-0": "**POST** <code>/v1/carnet/:id/history</code>", "9-0": "**PUT** <code>/v1/carnet/:id/parcel/:parcel/settle</code>", "10-0": "**PUT** <code>/v1/carnet/:id/settle</code>", "0-1": "7.500", "1-1": "7.500", "2-1": "7.500", "3-1": "7.500", "4-1": "7.500", "5-1": "7.500", "6-1": "7.500", "7-1": "7.500", "8-1": "7.500", "9-1": "7.500", "10-1": "7.500" }, "cols": 2, "rows": 11 } [/block] # Notificações Este *endpoint* é de uso exclusivo da API Gerencianet sendo utilizado na comunicação com o sistema integrado para atualização de status das transações. [block:parameters] { "data": { "h-0": "Endpoint (Rota base)", "h-1": "Limite de requisições", "0-0": "**GET ** <code>/v1/notification/:token</code>", "0-1": "15.000" }, "cols": 2, "rows": 1 } [/block] # Assinaturas [block:parameters] { "data": { "h-0": "Endpoint (Rota base)", "h-1": "Limite de requisições", "0-0": "**POST** <code>/v1/plan</code>", "1-0": "**GET** <code>/v1/plans</code>", "2-0": "**PUT** <code>/v1/plan/:id</code>", "3-0": "**DELETE** <code>/v1/plan/:id</code>", "4-0": "**POST** <code>/v1/plan/:id/subscription</code>", "0-1": "7.500", "1-1": "7.500", "2-1": "7.500", "3-1": "7.500", "4-1": "7.500", "5-0": "**GET** <code>/v1/subscription/:id</code>", "6-0": "**PUT** <code>/v1/subscription/:id/cancel</code>", "7-0": "**PUT** <code>/v1/subscription/:id/metadata</code>", "8-0": "**POST** <code>/v1/subscription/:id/pay</code>", "9-0": "**POST** <code>/v1/subscription/:id/history</code>", "5-1": "7.500", "6-1": "7.500", "7-1": "7.500", "8-1": "7.500", "9-1": "7.500" }, "cols": 2, "rows": 10 } [/block] # Outros [block:parameters] { "data": { "h-0": "Endpoint (Rota base)", "h-1": "Limite de requisições", "0-0": "**GET** <code>/v1/installments</code>", "0-1": "7.500" }, "cols": 2, "rows": 1 } [/block]