LuawardDocs

API системы ключей

Чтение и изменение страницы бесплатных ключей проекта: настройки, шаги, воронка, визиты и заблокированные аккаунты.

Страница бесплатных ключей проекта (key.luaward.com/getkey/…) выдаёт ключи с ограниченным сроком после того, как посетитель выполнит заданные вами шаги. Эти маршруты читают её и меняют то, что безопасно менять из программы. Для изменений нужен ключ со scope keysystem:write (Полный доступ его включает). Чтобы самому создать временный ключ, создайте обычный ключ с key_days.

Чтение

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

Возвращает key_systems. GET …/key-systems/:key_system_id возвращает одну систему с её steps по порядку. У системы ключей есть key_system_id, name, slug, page_url, project_id, script_id (скрипт, loadstring которого показывает страница), 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 и updated_at. У шага есть step_id, position, title, provider, target_url, required_seconds и active. Система не из этого проекта отвечает 404 KEY_SYSTEM_NOT_FOUND.

Изменение настроек

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

ПолеПравило
nameОт 1 до 80 символов.
enabled, allow_extending, allow_forgetting, require_discord, block_vpn, enforce_ip_matchtrue или false.
key_hoursСрок действия ключа: от 0,25 до 8760 часов.
max_keys_per_visitorОт 1 до 20.
blocked_countriesДо 250 двухбуквенных кодов заглавными, например RU.
session_timeout_secondsОт 300 до 86400.
script_idДействующий скрипт того же проекта или null, чтобы не показывать.

Хотя бы одно поле; те же лимиты, что в дашборде. Ответ — обновлённый key_system. Шестнадцатеричный slug создаётся автоматически и не может быть изменён. Вид страницы, провайдер и ссылка шагов меняются в дашборде.

Правило защиты, заданное здесь, включается по-настоящему: require_discord, block_vpn или blocked_countries в запросе завершают пробу, которую панель начала для этого правила (правило в пробном режиме лишь записывает, кого остановило бы). У кого require_discord просит Discord (у всех или только у посетителей, которые выглядят рискованными), задаётся в панели.

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

active, required_seconds (от 0 до 600, минимальное время шага) и title, хотя бы одно. Всё остальное в теле игнорируется.

Воронка, визиты и блокировки

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

days — 7 (по умолчанию) или 30. В ответе funnel (visit, start, step, complete, claim, block), countries и blocked_because (почему посетителей отсеяли: vpn, country, captcha, bypass, discord, limit).

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

Последние визиты, сначала новые: limit (от 1 до 100, по умолчанию 30) и before (next_before предыдущей страницы, метка времени). У каждого есть visit_id, status, step, country, browser, vpn, discord_id, started_at и finished_at. Адрес и идентификатор браузера посетителя в ответ не входят.

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

Аккаунты и адреса, которые страница отсеивает: block_id, kind (discord, ip или visitor), value и reason. Адрес или браузер хранится только в виде хеша, поэтому показываются лишь первые восемь символов. POST …/blocks с discord_id (15–22 цифры) и необязательным reason блокирует аккаунт Discord (201 с block_id; 409 ALREADY_BLOCKED, если уже заблокирован). DELETE …/blocks/:block_id снимает блокировку (404 BLOCK_NOT_FOUND, если её нет). Блокировка адреса делается в дашборде.