API-ключи

Создание и управление API-ключами для WardenCore API

API-ключи позволяют внешним инструментам, ботам и скриптам обращаться к WardenCore API от имени вашего сервера — своя панель статистики, Discord-бот, скрипт автомодерации и так далее.

Управление — в панели: Настройки → API.

Премиум-функция

API доступен на серверах с активным премиум-планом. Если сервер не премиум — создание ключей отключено; если премиум истёк — существующие ключи перестают работать до продления.

Создание ключа

Откройте Настройки → API

Разверните Настройки в боковом меню и выберите API.

Нажмите «Создать ключ»

Задайте ключу понятное название, чтобы потом его узнать — например, «Discord-бот» или «Дашборд статистики».

Отметьте нужные скоупы галочками в таблице. Каждый скоуп имеет вид ресурс:действие (напр. server:read, players:write) с описанием, что он даёт; в списке только скоупы, за которыми есть живой эндпоинт. Ключ не может превышать ваши собственные права на сервере — выдавайте минимум.

Задайте срок (необязательно)

Выберите, как долго ключ действителен — Бессрочно (по умолчанию) или 30 / 90 / 365 дней. По истечении срока ключ отклоняется с 401 unauthorized; ротируйте или замените его заранее.

Скопируйте ключ

Нажмите Создать ключ. Полный ключ показывается один раз, в диалоге — сразу скопируйте его кнопкой Копировать. В списке потом отображается только замаскированный вид wc_live_…xxxx.

Сохраните ключ сейчас

Полный ключ показывается только один раз, сразу после создания. Если потеряете — восстановить нельзя: отзовите старый ключ и создайте новый.

Принцип минимальных привилегий

Выдавайте только те скоупы, которые инструменту реально нужны. Дашборду статистики хватит скоупов на чтение; боту, выполняющему команды, нужен соответствующий скоуп console:write.

Ротация ключа

Нажмите действие Ротация в строке ключа, чтобы выпустить новый секрет на месте — ключ сохраняет id, название, скоупы и срок, но старый секрет сразу перестаёт работать. Новый секрет показывается один раз, как при создании. Используйте, если ключ мог утечь, не меняя, на какой ключ ссылается интеграция.

Отзыв ключа

Нажмите действие Отозвать в строке ключа и подтвердите. Отзыв срабатывает мгновенно — любое приложение с этим ключом начинает получать 401 unauthorized.

Использование ключа

Передавайте ключ как bearer-токен на https://api.wardencore.ru/v1:

Authorization: Bearer wc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Базовый URL, формат ошибок, лимиты и соглашения — в Справочнике API.

Всегда используйте HTTPS. Ключ — это секрет: не коммитьте его в репозиторий и не раскрывайте в клиентском коде.

Частые проблемы

401 Unauthorized

Ключ отсутствует, введён с ошибкой, истёк или отозван. Проверьте, что он передаётся как Authorization: Bearer wc_live_… и всё ещё существует в Настройки → API.

403 premium_required

API — премиум-функция. Создание или использование ключа требует активного премиум-плана на сервере — продлите его в разделе Оплата, чтобы восстановить доступ.

403 insufficient_scope

Ключ валиден, но ему не хватает скоупа для запроса — его имя в details.missing_scope ошибки. Создайте новый ключ с нужным скоупом.