API-ключи
Генерация и управление API-ключами для внешних интеграций
API-ключи позволяют внешним инструментам, ботам и скриптам взаимодействовать с вашим сервером через HTTP API WardenCore. Например, вы можете использовать API-ключ для подключения пользовательской панели статистики, Discord-бота или скрипта автоматической модерации.
Управление API-ключами находится в разделе Settings > API в боковом меню панели.
Генерация нового ключа
Откройте страницу API
Разверните раздел Settings в боковом меню и нажмите API.
Введите название ключа
В поле Key Name введите описательное название для этого ключа. Используйте что-то, что поможет определить его назначение — например, «Discord Bot», «Stats Dashboard» или «Backup Script».
Выберите права доступа
Выберите, какие права должен иметь этот ключ, отметив чекбоксы:
- Read -- может запрашивать данные (игроки, статистика, информация о сервере)
- Write -- может выполнять действия (отправка команд, сообщений)
- Admin -- полный доступ, включая управление администраторами
Необходимо выбрать хотя бы одно право. Если ни одно не отмечено, автоматически выбирается Read.
Нажмите «Generate»
Нажмите кнопку Generate. Новый ключ появится в выделенном зелёном блоке под формой.
Скопируйте ключ немедленно. Он не будет показан снова после перехода на другую страницу или обновления. В списке ключей отображается только замаскированная версия в целях безопасности.
Сохраните ключ сейчас
Полный API-ключ отображается только один раз — сразу после генерации. Если вы его потеряете, восстановить его невозможно. Вам придётся удалить старый ключ и сгенерировать новый.
Принцип минимальных привилегий
Всегда используйте минимально необходимые права. Для панели статистики достаточно доступа Read. Discord-боту, отправляющему команды, нужны Read и Write. Выдавайте Admin только если инструменту действительно необходимо управлять администраторами или конфигурацией.
Удаление ключа
Чтобы удалить ключ, нажмите кнопку Delete в его строке. После подтверждения ключ будет отозван безвозвратно.
Использование API-ключей
Для аутентификации с помощью API-ключа включите его в заголовок запроса:
X-API-Key: your-api-key-hereВсегда используйте HTTPS при отправке API-ключей. Отправка ключей по обычному HTTP делает их доступными для перехвата.
Steam API Key
На странице настроек API также находится карточка Steam API. Это отдельная настройка для Steam Web API, которую WardenCore использует для получения истории VAC-банов, статуса игровых банов и количества часов в игре для профилей игроков.
Получите Steam API Key
Перейдите на портал разработчиков Steam и зарегистрируйте бесплатный API-ключ. Для этого нужен аккаунт Steam с подтверждённой электронной почтой.
Введите ключ
Вставьте ключ в поле ввода в карточке Steam API и нажмите Save.
Проверьте
После сохранения карточка показывает значок «Configured» и замаскированную версию вашего ключа. В профилях игроков теперь будут отображаться данные Steam, включая статус VAC/игровых банов и количество наигранных часов.
Чтобы удалить Steam API Key, нажмите кнопку Remove. Профили игроков больше не будут отображать данные Steam, но панель продолжит работать в обычном режиме.
Частые проблемы
Потерян API-ключ
Если вы потеряли или забыли ключ, восстановить его невозможно. Удалите старый ключ и сгенерируйте новый с тем же именем и правами. Обновите ключ в инструменте или скрипте, который его использовал.
API возвращает 401 Unauthorized
Ключ неверен, удалён или передаётся неправильно. Проверьте следующее:
- Значение ключа скопировано точно, без лишних пробелов
- Ключ передаётся в заголовке
X-API-Key - Ключ не был удалён из панели
API возвращает 403 Forbidden
Ключ действителен, но не имеет прав для запрашиваемого действия. Например, ключ только с правом Read не может отправлять команды (это действие Write). Сгенерируйте новый ключ с необходимыми правами или добавьте недостающее право.
Данные Steam не отображаются в профилях игроков
Если в профилях игроков в разделе Steam отображается «API key not configured», значит Steam Web API Key не настроен. Перейдите в Settings > API и настройте его в карточке Steam API.