LuawardDocs

API do sistema de chaves

Leia e altere a página de chave grátis de um projeto: configurações, etapas, funil, visitas e contas bloqueadas.

A página de chave grátis de um projeto (key.luaward.com/getkey/…) entrega chaves com prazo depois que o visitante cumpre as etapas que você definiu. Estas rotas a leem e alteram o que é seguro alterar a partir de um programa. Alterar exige uma chave com o escopo keysystem:write (Acesso total o tem). Para criar uma chave temporária você mesmo, crie uma chave comum com key_days.

Ler

GET /v3/projects/:id/key-systems

Retorna key_systems. GET …/key-systems/:key_system_id retorna um com seus steps, em ordem. Um sistema de chaves tem key_system_id, name, slug, page_url, project_id, script_id (o script cujo loadstring a página mostra), enabled, key_hours, max_keys_per_visitor, allow_extending, allow_forgetting, require_discord, block_vpn, blocked_countries, session_timeout_seconds, enforce_ip_match, steps, created_at e updated_at. Uma etapa tem step_id, position, title, provider, target_url, required_seconds e active. Um que não está neste projeto responde 404 KEY_SYSTEM_NOT_FOUND.

Alterar configurações

PATCH /v3/projects/:id/key-systems/:key_system_id

CampoRegra
name1 a 80 caracteres.
enabled, allow_extending, allow_forgetting, require_discord, block_vpn, enforce_ip_matchtrue ou false.
key_hoursQuanto dura uma chave: 0,25 a 8760 horas.
max_keys_per_visitor1 a 20.
blocked_countriesAté 250 códigos de duas letras em maiúsculas, como RU.
session_timeout_seconds300 a 86400.
script_idUm script ativo do mesmo projeto, ou null para não mostrar nenhum.

Pelo menos um campo; os mesmos limites do dashboard. A resposta é o key_system atualizado. O slug hexadecimal é gerado automaticamente e não pode ser editado. O visual da página e o provedor e o link das etapas se mudam no dashboard.

Uma regra de proteção definida aqui fica ligada de verdade: require_discord, block_vpn ou blocked_countries em uma requisição encerram o teste que o painel tivesse iniciado para essa regra (uma regra em teste só anota quem ela barraria). De quem require_discord pede (de todos, ou só dos visitantes que parecem arriscados) é uma configuração do painel.

PATCH /v3/projects/:id/key-systems/:key_system_id/steps/:step_id

active, required_seconds (0 a 600, o tempo mínimo que a etapa pode levar) e title, pelo menos um. O resto do corpo é ignorado.

Funil, visitas e bloqueios

GET /v3/projects/:id/key-systems/:key_system_id/stats

days é 7 (padrão) ou 30. A resposta tem o funnel (visit, start, step, complete, claim, block), countries e blocked_because (por que visitantes foram barrados: vpn, country, captcha, bypass, discord, limit).

GET /v3/projects/:id/key-systems/:key_system_id/visits

As visitas mais recentes, do mais novo ao mais antigo: limit (1 a 100, padrão 30) e before (o next_before da página anterior, um carimbo de tempo). Cada uma tem visit_id, status, step, country, browser, vpn, discord_id, started_at e finished_at. O endereço e o id do navegador de um visitante nunca fazem parte.

GET /v3/projects/:id/key-systems/:key_system_id/blocks

As contas e endereços que a página barra: block_id, kind (discord, ip ou visitor), value e reason. Um endereço ou navegador é guardado só como hash, então só os oito primeiros caracteres aparecem. POST …/blocks com discord_id (15 a 22 dígitos) e um reason opcional bloqueia uma conta do Discord (201 com block_id; 409 ALREADY_BLOCKED se já estiver). DELETE …/blocks/:block_id retira um (404 BLOCK_NOT_FOUND se não houver). Bloquear um endereço é feito no dashboard.