Публичное API

Flame API предоставляет Вам возможность взаимодействовать с ботом за пределах наших официальных сервисов. Ниже Вы найдете небольшую справку, которая будет описывать задачу каждого эндпоинта.

Стоить приметить, что на текущий момент API находится в разработке. Поэтому, существуют только 3 публичных эндпоинта, которые может использовать каждый. В будущем возможности API будут значительно расширятся.

get
Получить статистику бота.

https://api.flamebot.ru/public/stats
Возвращает JSON-объект с детальной статистикой бота, а также статистикой каждого подключенного к нему шарда.
Request
Response
Request
Response
200: OK
Сервер успешно обработал запрос.
{
"shards": [...],
"totalGuilds": 100,
"totalUsers": 5000,
"totalShards": 1
}

get
Получить статистику музыкальных нод.

https://api.flamebot.ru/public/stats/nodes
Возвращает JSON-объект со статистикой подключенных музыкальных серверов.
Request
Response
Request
Response
200: OK
Сервер успешно обработал запрос.
{
"name": "Node #1",
"connected": true,
"stats": {
"activePlayers": 1,
"launchedAt": "2021-04-10 13:35:48",
"memoryUsage": "322MB"
}
}

get
Получить полный список команд бота.

https://api.flamebot.ru/public/commands
Возвращает массив со всеми командами бота.
Request
Response
Request
Response
200: OK
Сервер успешно обработал запрос.
[
{
name: 'help',
description: 'Вызывает меню помощи.',
category: 'general',
usage: 'help',
aliases: [],
examples: [...],
cooldown: 3,
premium: false,
userPermissions: [],
clientPermissions: []
},
...
]