Документация

Внешний API

Авторизация — API-ключ

API-ключ генерируется в настройках проекта (требуется тариф Ultra).

Передавайте ключ в заголовке: X-API-Key: ВАШ_КЛЮЧ.

Без тарифа Ultra — ответ 403.

Примеры (curl)

1. Серверы проекта:

curl -s -H "X-API-Key: ВАШ_КЛЮЧ" https://api.clansystem.ru/external/v1/servers

2. Онлайн:

curl -s -H "X-API-Key: ВАШ_КЛЮЧ" https://api.clansystem.ru/external/v1/online

3. Кланы:

curl -s -H "X-API-Key: ВАШ_КЛЮЧ" https://api.clansystem.ru/external/v1/clans

Коды: 200 — успех, 401 — неверный ключ, 403 — не Ultra.

Эндпоинты

Блокировки (баны / мьюты)

Авторизация — API-ключ

Все эндпоинты блокировок используют тот же API-ключ проекта. Передавайте заголовок: X-API-Key: ВАШ_КЛЮЧ. Требуется тариф Ultra.

Типы блокировок

Создать блокировку

POST/rac/blockings

{
  "projectId":  "string",
  "steamId":    "76561198...",
  "type":       "TEMP_BAN",
  "reason":     "Читы",
  "expiresAt":  "2025-02-01T00:00:00.000Z",
  "serverId":   "string",
  "playerName": "nickname"
}

Ответ: 201 — объект блокировки. 400 — невалидные данные.

Список блокировок

GET/rac/blockings?projectId=ID — возвращает массив всех блокировок (активных и снятых).

Снять блокировку (разбан)

PATCH/rac/blockings/revoke

{ "blockingId": "string" }

Обновить блокировку

PATCH/rac/blockings/update

{
  "blockingId": "string",
  "type":       "PERM_BAN",
  "reason":     "Новая причина",
  "expiresAt":  null
}

Пример (curl)

# Забанить игрока
curl -X POST https://api.clansystem.ru/rac/blockings \
  -H "X-API-Key: ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"...","steamId":"76561198...","type":"PERM_BAN","reason":"Читы"}'

# Разбанить
curl -X PATCH https://api.clansystem.ru/rac/blockings/revoke \
  -H "X-API-Key: ВАШ_КЛЮЧ" \
  -H "Content-Type: application/json" \
  -d '{"blockingId":"..."}'

Плагин

Установка

Требования:

• Игровой сервер Rust с установленным Oxide / uMod
• Доступ к RCON или серверной консоли
• Созданный проект в ClanSystem

Структура файлов:

game_server/
├── oxide/
│   ├── plugins/
│   │   └── ClanSystem.cs              ← плагин
│   └── data/
│       └── ClanSystem_Credentials.json ← создаётся после cs.pair

Файл ClanSystem_Credentials.json — секрет. Не передавайте третьим лицам.

Подключение сервера

1. Панель → ваш проект → «Серверы» → «Добавить сервер». Код одноразовый.
2. В RCON/консоли: cs.pair ABC123

Проверка: cs.status. Переподключение: cs.unpair → новый код → cs.pair.

Команды (RCON)

Безопасность

• ClanSystem_Credentials.json содержит HMAC-ключи. Не публикуйте.
• Для сброса ключей: cs.unpair → новый код в панели → cs.pair.

Диагностика ошибок

Тарифы

Кланы и игроки — без ограничений на всех тарифах.

По вопросам оплаты: support@clansystem.ru.

FAQ