nedobot - api [beta]

API - Главное

Наше скромное API предлагает несколько функций, которые могут быть полезны в Вашем проекте

Все методы находятся в меню слева

Некоторые методы требуют аутентификацию по токену. Такие методы помечены значком 🔑
Токен можно получить тут

Все методы вызываются по адресу https://nedobot.ru/api/[метод]/

Передача параметров поддерживается как GET, так и POST (у POST-параметров приоритет выше)

Также, все методы возвращают данные в формате JSON

Любые ошибки будут возвращены в формате {"error": "ошибка"}, успешные же результаты возвращаются в формате {"result": ...}

Методы

base64

Параметры:

act - действие обязательный
text - Текст для (рас)шифровки обязательный

Выполняет операции с шифром base64 в зависимости от act

encode

Дополнительные параметры: не требуются

Шифрует текст

Возвращаемые данные:

{
  "text": "..."      - зашифрованный текст
  "source": "..."       - исходный текст
}

decode

Дополнительные параметры: не требуются

Расшифровывает текст

Возвращаемые данные:

{
  "text": "..."      - расшифрованный текст
  "source": "..."       - исходный текст
}

cat

Параметры: не требуются

Возвращает случайное фото с котом (берётся с нескольких сервисов случайным образом)

Возвращаемые данные:

JPEG-картинка

face

Параметры: не требуются

Возвращает фото со случайно сгенерированным человеком (GAN)

Возвращаемые данные:

JPEG-картинка

holidays

Параметры: не требуются

Выдаёт праздники на сегодня с их происхождением и кратким описанием

Возвращаемые данные:

{
  "holidays": [     - Массив с праздниками
    "...",
    "...",
    "..."
    {...}
  ],
  "count": ...      - количество праздников
}

mc_server

Параметры:

ip - адрес сервера (только в виде ipv4) обязательный
port - порт сервера (если не указан, будет использоваться 25565)

Выдаёт информацию о сервере в Java-версии Minecraft

Возвращаемые данные:

{
  "hostname": "..."     - название (motd)
  "version": "..."     - версия
  "plugins": "..."     - установленные плагины
  "map": "..."     - название мира
  "players": "..."     - текущее число игроков
  "maxPlayers": "..."     - максимальное количество игроков
  "currentPlayyers": ["...", "...", ...]     - ники игроков, которые играют в момент запроса
}

methodinfo

Параметры:

method - метод, информацию о котором требуется вернуть обязательный

Выдаёт информацию о методе

Возвращаемые данные:

{
  "params": [         - массив с возможными параметрами
    "paramName": {        - название параметра
      "desc": "...",        - описание параметра
      "required": true/false        - обязателен ли параметр
    }, {}
  ],
  "desc": "...",        - описание метода
  "result": "...",      - возвращаемый результат (!) Данного элемента нет, если задан элемент "acts" (!)
  "acts": {       - массив с возможными действиями
    "actName": {      - название действия
      "desc": "...",        - описание действия
      "params": [],       - дополнительные параметры, которые требуются действию (необязательны для основного метода)
      "result": "..."       - возвращаемый результат
    }
  }
}

r_quote

Параметры: не требуются

Возвращает случайную цитату

Возвращаемые данные:

{
  "text": "..."     - текст цитаты,
  "author": "..."     - автор цитаты (если есть),
}

🔑 spamdb

Параметры:

token - токен доступа обязательный
act - действие обязательный
user_id - идентификатор пользователя (число) обязательный
reason - причина внесения в базу

В зависимости от параметра act совершает действие со спам-базой:

check

Дополнительные параметры: не требуются

Проверяет спам-базу на наличие пользователя в ней

Возвращаемые данные:

{
  "inSpam": true/false      - наличие в спам-базе
  "reason": "..."       - причина бана
  "date": ...       - время добавления (unix)
}

add

Дополнительные параметры: reason

Добавляет пользователя в спам-базу

Возвращаемые данные:

{
  "success": true      - успешное добавление
  "reason": "..."       - причина добавления
}

remove

Дополнительные параметры: не требуются

Удаляет пользователя из спам-базы

Возвращаемые данные:

{
  "success": true      - успешное удаление
}

list

Дополнительные параметры: не требуются

Возвращает список всех пользователей в спам-базе

Возвращаемые данные:

Массив с данными из метода check

userinfo

Параметры:

user_id - идентификатор пользователя (число) обязательный

Возвращает информацию о пользователе (аналог команды !инфо в боте)

Возвращаемые данные:

{
  "regDate": ...      - дата регистрации (unix)
  "modifDate": ...      - дата последнего изменения (unix)
  "onlineTime": ...      - примерное время онлайна (часов)
  "sex": "..."      - пол
  "friends": ...      - количество друзей
  "subscribers": ...      - количество подписчиков
  "stickers": [..., ..., ...]      - имеющиеся наборы стикеров
}