Документация ClanSystem
Подключение серверов (uMod/Oxide), команды RCON, ошибки и внешний API.
Внешний API (для админов)
Ключ доступа (Basic)
Авторизация выполняется по заголовку Authorization: Basic .... Логин — email админ‑аккаунта. Пароль — пароль админ‑аккаунта.
Генератор заголовка (вычисляется в браузере, ничего не отправляет):
Доступ к внешнему API доступен только проектам на тарифе Ultra (иначе 403).
Примеры (curl)
1) Получите список проектов и возьмите projectId.
curl -s \ -H "Authorization: Basic BASE64(email:password)" \ https://YOUR_DOMAIN/api/external/projects
curl -s \ -H "Authorization: Basic BASE64(email:password)" \ https://YOUR_DOMAIN/api/external/projects/PROJECT_ID/online
Ответы: 401 — неверные email/пароль; 403 — проект не Ultra или доступ запрещён.
Эндпоинты
| Метод | URL | Описание |
|---|---|---|
| GET | /api/external/projects | Список ваших проектов (показывает, разрешён ли API) |
| GET | /api/external/projects/:projectId/servers | Список серверов проекта (Ultra) |
| GET | /api/external/projects/:projectId/clans | Список кланов проекта (Ultra) |
| GET | /api/external/projects/:projectId/online | Онлайн‑слепок по серверам проекта (Ultra) |
| POST | /api/external/servers/:serverId/keys/rotate | Ротация ключей сервера (Ultra) |
Быстрый старт
1) Откройте раздел Внешний API и сформируйте заголовок авторизации.
2) Подключите сервер командой cs.pair (раздел Подключение сервера).
Установка плагина
Требования
- Игровой сервер с установленным Oxide/uMod
- Доступ к RCON или консоли сервера
- Созданный проект в ClanSystem и доступ к панели
Структура файлов
game_server/ ├── oxide/ │ ├── plugins/ │ │ └── ClanSystem.cs ← плагин │ └── data/ │ └── ClanSystem_Credentials.json ← создаётся после cs.pair
Файл в oxide/data содержит ключи подключения. Храните его как секрет.
Подключение сервера
1) Получите код подключения
В панели: проект → «Серверы» → «Добавить сервер». Код действует ограниченное время.
2) Выполните команду в RCON/консоли
cs.pair ABC123Проверка: cs.status. Переподключение: cs.unpair → cs.pair.
Команды плагина
Консольные команды (RCON)
| Команда | Описание |
|---|---|
cs.pair <код> | Подключить сервер к проекту |
cs.status | Проверить статус подключения |
cs.sync | Принудительная синхронизация |
cs.unpair | Отключить сервер от проекта |
Безопасность
После cs.pair плагин сохраняет данные подключения вoxide/data/ClanSystem_Credentials.json. Это секрет подключения сервера.
Храните этот файл в секрете. Не публикуйте его и не передавайте посторонним.
Для переподключения: cs.unpair → cs.pair <код>.
Диагностика ошибок (502/401/403)
HTTP 401 (Unauthorized)
- • Проверьте системное время сервера (желательно NTP/автосинхронизация)
- • Переподключите сервер:
cs.unpair→cs.pair - • Не редактируйте вручную
ClanSystem_Credentials.json
HTTP 403 (Forbidden)
- • Сервер не принадлежит вашему проекту или отключён
- • Внешний API доступен только на тарифе Ultra
HTTP 502/503/504
- • Сетевая/прокси-ошибка между сервером и API (DNS/Firewall/хостинг)
- • Проверьте исходящее соединение с сервера (DNS и доступ в интернет)
- • При повторении отправьте лог и время ошибки на support@clansystem.ru
Тарифы и доступы
Кланы и игроки — без ограничений. Различаются лимиты по серверам и доступ к внешнему API.
| Параметр | Start | Pro | Ultra |
|---|---|---|---|
| Цена | 300 ₽ | 700 ₽ | 1500 ₽ |
| Кланы / игроки | ∞ | ∞ | ∞ |
| Кол-во серверов | 1 | 3 | 10 |
| Внешний API | — | — | Да |
| Статистика | Да | Да | Да |
Покупка и смена тарифа временно недоступны. По вопросам: support@clansystem.ru.