Keys
Renovar key
Dá mais dias à MESMA key do cliente e desconta do seu saldo.
POST
/keys/{user_id}/renewPermissão do token: Renovar keys keys:renewgasta créditos
O cliente continua com a key que já usa, com mais dias. Cobra o mesmo preço de gerar uma key daquela duração. Sem saldo suficiente, nada é renovado nem cobrado.
- Os dias somam ao vencimento atual. Se a key já venceu, contam a partir de agora: renovar uma key vencida há 10 dias por 30 dá 30 dias de uso, não 20.
- Só key já ativada pode ser renovada. A que ninguém ativou ainda guarda a duração para a ativação — gere outra.
- A key bloqueada continua bloqueada depois de renovar.
Idempotency-Key obrigatória
Como na geração, toda chamada leva o cabeçalho Idempotency-Key. Repetindo com o mesmo código, você recebe a mesma renovação sem pagar de novo. Por quê?
Parâmetros no endereço
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
user_id | número | Sim | O user_id da key — vem na geração e na lista de keys. |
Cabeçalhos
| Cabeçalho | Obrigatório | Descrição |
|---|---|---|
Idempotency-Key | Sim | Um código único por renovação (um UUID serve). Até 100 caracteres: letras, números e _ - : . |
Content-Type | Sim | application/json |
Corpo (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
days | número | Sim | Quantos dias a mais, entre os plans do produto da key (a lista de produtos traz as durações e o preço de cada uma). |
Resposta
| Campo | O que é |
|---|---|
renewal_id | O id desta renovação. Aparece no extrato como reference_id, com type: "key_renewal". |
user_id | A key renovada. |
days | Os dias somados. |
credits_spent | Quanto foi cobrado. |
balance | O seu saldo depois da cobrança. |
previous_access_end / access_end | O vencimento antes e depois, em segundos desde 1970 (Unix). |
Repetindo com a mesma Idempotency-Key e o mesmo corpo, a resposta traz a mesma renovação, com "idempotent_replay": true e o cabeçalho Idempotent-Replayed: true.
Erros
| HTTP | Quando | O que fazer |
|---|---|---|
402 | Saldo insuficiente (ou, no crédito a prazo, passa do limite). Nada foi renovado nem cobrado. | Os mesmos campos da geração: errors.balance, e no crédito a prazo errors.postpaid_limit e errors.available. |
403 | O token não tem a permissão Renovar keys, a key não é sua, é uma key de gravação, ou foi bloqueada pelo suporte (blocked_by: "support" na lista). Nada foi cobrado. | Crie um token com a permissão; key de gravação e key bloqueada pelo suporte não renovam por aqui. A que você bloqueou renova normalmente. |
404 | A key não tem acesso na loja. | Confira o user_id. |
409 | A Idempotency-Key já foi usada num pedido diferente, ou o primeiro ainda está rodando. | Pedido novo: código novo. Mesmo pedido: espere e repita. |
422 | Key ainda não ativada, ativada com outro mod que não o vendido, key antiga que aponta para a conta de um cliente da loja, duração que o produto não tem (as opções em errors.days), produto fora da venda, ou Idempotency-Key ausente. Nada foi cobrado. | A message diz o que corrigir. Mod trocado e conta de cliente: fale com o suporte. |
429 | Passou do limite. | Espere os segundos de Retry-After. |