Аддон для серверного плагина uxmEssentials открывает его возможности для внешних программ через HTTP и WebSocket. Он пригодится для веб-панели, бота, магазина, скрипта или панели статистики.
Возможности
Через API можно получать данные об экономике, домах, варпах, китах, хранилищах, наказаниях, игровом времени, AFK, невидимости, запросах телепортации, мирах, голосованиях, почте и игнор-листе. Также доступны операции с балансом, домами и варпами, китами, наказаниями, режимами игрока, телепортацией, мирами, сообщениями и почтой.
WebSocket передаёт события uxmEssentials в реальном времени, поэтому внешней программе не нужно постоянно запрашивать сервер.
Команды
/uxmapi token create <label> [scopes]— создать токен доступа./uxmapi token list— посмотреть созданные токены без секретов./uxmapi token revoke <label>— отозвать токен./uxmapi status— проверить состояние API и подключения.
Токену можно выдать области доступа: read для чтения, write для изменений и events для потока событий.
Настройка
Параметры находятся в plugins/uxmEssentials-rest/config/rest.conf. Для запуска API включите enabled = true; адрес, порт, лимит запросов и число подключений к потоку событий задаются ключами bind, port, requests-per-minute и max-subscribers.
API работает по обычному HTTP. Для доступа извне автор рекомендует поставить перед ним обратный прокси с TLS.
Требования
Нужен основной плагин uxmEssentials. Аддон рассчитан на Paper и готов к работе с Folia.
