MyBB Forum API

Интерфейс прикладного программирования (API) представляет собой набор функций, методов и процедур, что позволяет использовать сторонние приложения для работы с форумом. 

  • Формат ответа JSON(P), XML
  • Работает с POST и GET
  • Возвращает подробные описания и коды состояний для отладки

Простой пример: https://forum.mybb.ru/api.php?method=board.get

Параметры, используемые во всех методах API
Параметр Описание
format Формат возвращаемых данных. По умолчанию json.
Допустимые значения: json, xml.
charset Сервер ответит в кодировке, заданной пользователем. По умолчанию utf-8.
Допустимые значения: utf-8, windows-1251.
callback Обратный вызов для формата JSONP, чаще всего используется в качестве callback=? в jQuery.
board.get

Получение статистики и настроек форума.

Параметр Описание
fields Перечисленные через запятую поля, необходимые для получения.
Доступные значения:
board_id
board_cat
founded
timezone_offset
title
total_users
total_topics
total_posts
num_categories
num_forums
last_registered_user_id
last_registered_username
active_guests
active_users
active_users_record
active_users_record_datetime
users_24h_record
users_24h_record_datetime
o_default_style
o_user_style
o_foundation
o_announcement
o_show_user_info
o_show_users_online
o_show_24h_users
o_show_birthdays
o_show_other_statistics
o_search_forums
o_post_rating
o_avatars
o_subscriptions
o_relation
o_relation_type
o_positive
o_registration
o_registration_by_invitation
o_limit_post_count
board.getForums

Получение списка форумов.

Параметр Описание
id  Перечисленные через запятую id форумов.
cat_id  Перечисленные через запятую id категорий.
exclude  Перечисленные через запятую id форумов для исключения.
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 25.
Максимальное значение 100.
board.getFunds

Получение баланса форума. Не требует параметров.

board.getSubscriptions

Получение информации о подписках.

Параметр Описание
user_id  Перечисленные через запятую id пользователей.
topic_id  Перечисленные через запятую id топиков.
sort_by Сортировка по полям.
Доступные значения:
id
subject
num_replies
num_posts
sort_dir Направление сортировки. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 25.
Максимальное значение 100.
board.getFileMetadata

Получение информации о залитом файле

Параметр Описание
filename  Имя файла.
admin  Доступ к файлам форума.
board.auth

Аутентификация. Возвращает ошибку или hash.

Параметр Описание
login  Логин.
password  Пароль.
users.get

Получение информации о пользователях.

Параметр Описание
user_id  Перечисленные через запятую id пользователей.
username Логин пользователя, по которому нужно получить информацию. Для получения информации по нескольким пользователям используйте массив из логинов.
fields Перечисленные через запятую поля, необходимые для получения.
Доступные значения:
user_id
username
group_id
avatar
registered
num_posts
title
group_title
group_user_title
realname
sex
age
birth_date
website
location
invited_user_id
num_invites
time_spent
last_visit
respect_plus
respect_minus
positive_plus
positive_minus
last_post
signature
o_style
group_id Перечисленные через запятую идентификаторы групп. Ограничивает зону поиска только по заданным группам.
birth_month Месяц рождения, принимает значения от 1 до 12.
sort_by Сортировка по полям.
Доступные значения:
user_id
username
registered
last_visit
respect
positive
num_invites
birthdate
num_posts
sort_dir Направление сортировки. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 25.
Максимальное значение 500.
users.getOnline

Получение информации о пользователях и гостей онлайн.

Параметр Описание
limit Задает максимальное число результатов. По умолчанию ограничения нет.
type Доступные значения:
all
guests
users
По-умолчанию: all
users.getRespect

Отношение участников к пользователю.

Параметр Описание
user_id  Перечисленные через запятую ID пользователей.
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 50.
Максимальное значение 100.
sort_dir Направление сортировки. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
topic.get

Список тем.

Параметр Описание
forum_id  Перечисленные через запятую ID форумов.
topic_id  Перечисленные через запятую ID топиков.
exclude_forum  Перечисленные через запятую ID форумов для исключения.
fields Перечисленные через запятую поля, необходимые для получения.
Доступные значения:
id
subject
last_user_id
last_username
last_post_id
last_post_date
username
posted
forum_id
closed
sticky
first_post
init_post
avatar (в html)
num_replies
num_views
init_post
sort_by Сортировка по полю
Доступные значения:
id
posted
last_post
sort_dir Направление сортировки по времени. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 50.
Максимальное значение 100.
topic.getRecent

Список активных тем.

Всё тоже самое, что и topic.get, но с добавлением параметра interval
post.get

Список сообщений.

Параметр Описание
post_id  Перечисленные через запятую ID постов.
topic_id  Перечисленные через запятую ID топиков.
fields Перечисленные через запятую поля, необходимые для получения.
Доступные значения:
id
rating
message
subject
user_id
username
posted
topic_id
forum_id
avatar
signature
num_replies
num_views
edited
edited_by
sort_by Сортировка по полю
Доступные значения:
id
posted
sort_dir Направление сортировки по времени. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
skip Пропускает N результатов. Максимальное значение 1000.
limit Задает максимальное число результатов. По умолчанию 50.
Максимальное значение 100.
post.getVotes

Получение информации об отданных голосах за сообщение.

Параметр Описание
post_id  Id сообщения.
fields Перечисленные через запятую поля, необходимые для получения.
Доступные значения:
post_id
post_rating
poster_id
user_id
username
avatar
value
datetime
sort_dir Направление сортировки по времени. По умолчанию asc (по возрастанию).
Доступные значения: asc, desc
Параметры, используемые во всех методах storage
Параметр Описание
user_id По умолчанию передается в HTTP Cookies, поэтому необязателен.
app_id В настоящий момент недоступно. По умолчанию пользователь может работать только со своими данными. Идея в том, чтобы при использовании параметра app_id дать приложению права на чтение и запись, а всем пользователям только на чтение.
storage.set

Сохраняет значение value на сервере под указанным ключом key.

Параметр Описание
token Значение необходимо брать из JavaScript переменной ForumAPITicket. Обязательный параметр.
key Ключ, под которым сохраняется значение.
value Сохраняемое значение.
action Доступные значения:
append
prepend
storage.get

Получает запись, которая ранее была сохранена под ключом key.

Параметр Описание
key Ключ получаемой записи.
storage.keys

Получает все ключи текущего пользователя или приложения, хранящиеся на сервере.

storage.delete

Удаляет запись с ключом key с сервера.

Параметр Описание
token Значение необходимо брать из JavaScript переменной ForumAPITicket. Обязательный параметр.
key Ключ удаляемой записи.
storage.flush

Удаляет все ключи текущего пользователя или приложения, хранящиеся на сервере.

Параметр Описание
token Значение необходимо брать из JavaScript переменной ForumAPITicket. Обязательный параметр.
storage.stats

Получает количество записей текущего пользователя или приложения на сервере и количество свободных ячеек.