Конечные точки

  • Просмотры Просмотры: 639
  • Последнее обновление Последнее обновление:

Навигация

API
   Конечные точки
   Типы данных
Страница

  • Содержимое

    Routes​

    Alerts​

    GET alerts/
    Получает список уведомлений

    Параметры

    Исходные данные Тип Описание
    page integer Номер страницы
    cutoff integer Временная метка UnixTime самого старого уведомления для включения. Обратите внимание, что непрочитанные и непросмотренные уведомления всегда включены.
    unviewed bool Если верно, получает только непросмотренные уведомления
    unread bool Если верно, получает только непрочитанные уведомления

    Ответ

    Результат Тип Описание
    alerts UserAlert[] Массив из сущностей уведомления
    pagination pagination Информация о странице

    POST alerts/
    Отправляет уведомление указанному пользователю. Доступны только для ключей суперпользователя.

    Параметры

    Исходные данные Тип Описание
    to_user_id integer ID пользователя для получения оповещения
    alert string Текст оповещения. Можно использовать заполнитель "{link}" для автоматической вставки ссылки
    from_user_id integer Если указано, пользователь, от которого отправляется оповещение. В противном случае используется текущий пользователь API. Может быть 0 для анонимного оповещения
    link_url string Заполнитель {link}
    link_title string Название заполнителя {link}

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST alerts/mark-all
    Помечает все уведомления как прочитанные или просмотренные. Необходимо указать параметры "чтение" или "просмотр".

    Параметры

    Исходные данные Тип Описание
    read bool Если указано, помечает все уведомления как прочитанные
    viewed bool Если указано, помечает все уведомления как просмотренные

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    GET alerts/{id}/
    Получает информацию о указанном уведомлении

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    alert UserAlert Сущность UserAlert указанного ID

    POST alerts/{id}/mark
    Помечает уведомление как просмотренное/прочитанное/непрочитанное. (Пометка "непросмотренное" не поддерживается.)

    Параметры

    Исходные данные Тип Описание
    read bool Если указано, помечает уведомление как прочитанное
    unread bool Если указано, помечает уведомление как непрочитанное
    viewed bool Если указано, помечает уведомление как просмотренное

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true



    Attachments​

    GET attachments/
    Получает вложения, связанные с предоставленным ключ вложения. Возвращает только вложения, которые не были связаны с содержимым.

    Параметры

    Исходные данные Тип Описание
    key string Ключ вложения

    Ответ

    Результат Тип Описание
    attachments Attachment[] Список вложений

    POST attachments/
    Загружает вложение. Сначала необходимо создать ключ вложения. Должно быть отправлено с использованием кодировки multipart/form-data

    Параметры

    Исходные данные Тип Описание
    key string Ключ вложения
    attachment file Файл

    Ответ

    Результат Тип Описание
    attachment Attachment Сущность Attachment с информацией о загруженном файле

    Ошибки

    Ошибка Описание
    attachment_key_user_wrong Срабатывает, если пользователь, отправляющий запрос, не соответствует пользователю, создавшему ключ вложения.

    POST attachments/new-key
    Создает новый ключ вложения, позволяющий загружать вложения отдельно от связанного содержимого.

    Параметры

    Исходные данные Тип Описание
    type string Тип содержимого вложения. Типы по умолчанию включают post, conversation_message.
    context string[] Пары ключ-значение, представляющие контекст вложения. Это зависит от типа содержимого и выполняемого действия.
    attachment file Первое вложение, которое будет связано с новым ключом.

    Ответ

    Результат Тип Описание
    key string Созданный ключ вложения. Его следует использовать для загрузки дополнительных файлов или для связывания загруженных вложений с другим содержимым.
    attachment Attachment Если был предоставлен файл и загрузка прошла успешно, здесь будет описано новое вложение.

    GET attachments/{id}/
    Получает информацию об указанном вложении.

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    attachment Attachment Сущность Attachment с информацией о файле

    DELETE attachments/{id}/
    Удаляет указанное вложение

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    GET attachments/{id}/data
    Получает данные, составляющие указанное вложение. Выходными данными являются необработанные двоичные данные.

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    data binary Выводятся непосредственно двоичные данные, а не JSON.

    GET attachments/{id}/thumbnail
    Получает URL-адрес миниатюры вложения, если она есть. URL возвращается через 301 редирект.

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    url string URL-адрес миниатюры.

    Ошибки

    Ошибка Описание
    not_found Не найдено, если вложение не имеет миниатюры



    Auth​


    POST auth/
    Проверяет логин и пароль на валидность. Доступна только для ключей суперпользователя. Мы настоятельно рекомендуем передавать параметры логина и пароля в теле запроса, а не в строке запроса.

    Параметры

    Исходные данные Тип Описание
    login string Имя пользователя или адрес электронной почты пользователя для тестирования
    password string Пароль пользователя
    limit_ip string IP-адрес, который следует считать выполняющим запрос. Если он указан, он будет использоваться для предотвращения попыток перебора.

    Ответ

    Результат Тип Описание
    user User В случае успеха, пользовательская запись совпадающего пользователя

    POST auth/from-session
    Выявляет активного пользователя Форума на основе идентификатора сессии или значения куки-файла remember. Это может быть использовано для беспрепятственного SSO в XF, при условии, что куки session или remember доступны для вашей страницы. Необходимо указать хотя бы одно из значений session_id и remember_cookie. Доступно только для ключей суперпользователя.

    Параметры

    Исходные данные Тип Описание
    session_id string Если указано, проверяет наличие активной сессии с этим идентификатором.
    remember_cookie string Если указано, проверяет, является ли активным значение cookie "запомнить меня".

    Ответ

    Результат Тип Описание
    success bool Если false, то не удалось найти сессионный или запоминающий файл cookie
    user User В случае успеха - запись пользователя, с которым произошел контакт. Может быть гостем.

    POST auth/login-token
    Генерирует токен, который может автоматически войти в систему определенного пользователя Форума при посещении URL-адреса входа. Если посетитель уже вошел в учетную запись XenForo, он не будет входить в указанную учетную запись. Доступно только для ключей суперпользователя.

    Параметры

    Исходные данные Тип Описание
    user_id integer ID пользователя
    limit_ip string Если указано, фиксирует токен на указанном IP для дополнительной безопасности
    return_url string Если указано, то после входа в систему пользователь будет возвращен на этот URL. В противном случае он попадет в индекс форума.
    force bool Если задано, URL входа будет принудительно заменять текущего вошедшего пользователя, если пользователь уже вошел в систему и отличается от текущего вошедшего пользователя. По умолчанию установлено значение false.
    remember bool Управляет тем, будет ли cookie "remember me" устанавливаться при входе пользователя в систему. По умолчанию установлено значение true.

    Ответ

    Результат Тип Описание
    login_token string Токен входа
    login_url string Прямая ссылка на вход в аккаунт
    expiry_date integer Временная метка Unix, когда истекает срок действия токена. Если срок действия маркера истек или он недействителен, будет выдана ошибка.



    Conversations​


    POST conversation-messages/
    Ответить на переписку

    Параметры

    Исходные данные Тип Описание
    conversation_id integer ID переписки
    message string Сообщение
    attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message с контекстом [conversation_id], установленным на данный идентификатор переписки.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    message ConversationMessage Новое сообщение

    GET conversation-messages/{id}/
    Получает указанное сообщение переписки.

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    message ConversationMessage Сущность найденного сообщения

    POST conversation-messages/{id}/
    Обновляет указанное сообщение переписки.

    Параметры

    Исходные данные Тип Описание
    message string Содержимое нового сообщения
    attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message с контекстом [message_id], установленным на ID этого сообщения.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    message ConversationMessage Сущность сообщения

    POST conversation-messages/{id}/react
    Реагирует на указанное сообщение разговора

    Параметры

    Исходные данные Тип Описание
    reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.

    GET conversations/
    Получает список переписок пользователя API.

    Параметры

    Исходные данные Тип Описание
    page integer Номер страницы
    starter_id integer Отправитель
    receiver_id integer Получатель
    starred bool Получает только избранные переписки, если указано
    unread bool Получает только непрочитанные переписки, если указано

    Ответ

    Результат Тип Описание
    conversations Conversation[] Сущности найденных переписок
    pagination pagination Информация о странице

    POST conversations/
    Создает переписку

    Параметры

    Исходные данные Тип Описание
    recipient_ids integer[] Список идентификаторов пользователей для отправки беседы
    title string Название переписки
    message string Тело сообщения переписки
    attachment_key string Ключ вложения API для загрузки файлов. Тип содержимого ключа вложения должен быть conversation_message без контекста.
    conversation_open bool Если false, то ответы на переписку не могут быть сделаны.
    open_invite bool Если true, то любой участник переписки может добавлять других.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    conversation Conversation Сущность созданной переписки

    GET conversations/{id}/
    Получает информацию об указанной переписке.

    Параметры

    Исходные данные Тип Описание
    with_messages bool Если указано, ответ будет включать страницу с сообщениями.
    page integer Страница сообщений, которые необходимо включить

    Ответ

    Результат Тип Описание
    conversation Conversation Сущность переписки
    messages ConversationMessage[] Список сообщений на запрашиваемой странице
    pagination pagination Информация о странице

    POST conversations/{id}/
    Обновляет указанную переписку

    Параметры

    Исходные данные Тип Описание
    title string Название переписки
    open_invite bool Если true, то любой участник переписки может добавлять других.
    conversation_open bool Если false, то ответы на переписку не могут быть сделаны.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    conversation Conversation Сущность обновленной переписки

    DELETE conversations/{id}/
    Удаляет указанную переписку из списка пользователя API. Не удаляет переписку для других получателей.

    Параметры

    Исходные данные Тип Описание
    ignore bool Если true, дальнейшие ответы на эту переписку будут игнорироваться. (В противном случае ответы вернут эту переписку в список).

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST conversations/{id}/invite
    Приглашает указанных пользователей в эту переписку.

    Параметры

    Исходные данные Тип Описание
    recipient_ids integer[] Список идентификаторов пользователей, которых нужно пригласить

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST conversations/{id}/mark-read
    Помечает переписку как прочитанную до указанного времени.

    Параметры

    Исходные данные Тип Описание
    date integer Временная метка Unix для отметки прочитанной переписки. Если не указано, по умолчанию используется текущее время.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST conversations/{id}/mark-unread
    Помечает переписку как непрочитанную. При этом все сообщения в переписке будут помечены как непрочитанные.

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    GET conversations/{id}/mark-unread
    Получает страницу сообщений в указанной переписке.

    Параметры

    Исходные данные Тип Описание
    page integer Страница

    Ответ

    Результат Тип Описание
    messages ConversationMessage[] Список сообщений на запрашиваемой странице
    pagination pagination Информация о странице

    POST conversations/{id}/star
    Устанавливает статус избранного для указанной переписки

    Параметры

    Исходные данные Тип Описание
    star bool Если указано, устанавливает указанный статус. Если не указан, переключает статус.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true



    Forums​


    GET forums/{id}/
    Получает информацию об указанном форуме

    Параметры

    Исходные данные Тип Описание
    with_threads bool Если true, получает страницу с темами на этом форуме
    page integer Страница
    prefix_id integer Фильтрует темы с указанным префиксом.
    starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя.
    last_days integer Фильтрует темы, в которых был получен ответ за последние X дней.
    unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей.
    thread_type string Фильтрует темы по указанному типу тем.
    order string Метод упорядочивания: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score.
    direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.

    Ответ

    Результат Тип Описание
    forum Forum Сущность запрошенного форума
    threads Thread[] Темы на этой странице
    pagination pagination Информация о странице
    sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.

    POST forums/{id}/mark-read
    Помечает форум как прочитанный до указанного времени.

    Параметры

    Исходные данные Тип Описание
    date integer Временная метка Unix для отметки чтения форума. Если не указано, по умолчанию используется текущее время.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    GET forums/{id}/threads
    Получает страницу тем из указанного форума.

    Параметры

    Исходные данные Тип Описание
    prefix_id integer Фильтрует темы с указанным префиксом.
    starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя.
    last_days integer Фильтрует темы, в которых был получен ответ за последние X дней.
    unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей.
    thread_type string Фильтрует темы по указанному типу тем.
    order string Метод упорядочивания: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score.
    direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.

    Ответ

    Результат Тип Описание
    threads Thread[] Темы на этой странице
    pagination pagination Информация о странице
    sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.



    Index​


    GET index/
    Получает общую информацию о сайте и API

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    version_id integer ID версии XenForo
    site_title string Название сайта, к которому относится данный API
    base_url string Базовый URL установки XenForo, к которой относится этот API
    api_url string Базовый URL-адрес API
    key[type] string Тип ключа доступа к API (гость, пользователь или суперюзер)
    key[user_id] integer Если это ключ пользователя, то идентификатор пользователя, для которого предназначен ключ; в противном случае null
    key[allow_all_scopes] bool Если true, список всех scopes
    key[scopes] string[] Список scopes, к которым может получить доступ этот ключ (если не разрешен доступ ко всем scopes)



    Me​


    GET me/
    Получает информацию о текущем пользователе API

    Параметры

    Исходные данные Тип Описание
    None.

    Ответ

    Результат Тип Описание
    me User Информация о пользователе API

    POST me/
    Обновление информации о текущем пользователе API

    Параметры

    Исходные данные Тип Описание
    option[creation_watch_state] string
    option[interaction_watch_state] string
    option[content_show_signature] bool
    option[email_on_conversation] bool
    option[push_on_conversation] bool
    option[receive_admin_email] bool
    option[show_dob_year] bool
    option[show_dob_date] bool
    profile[location] string
    profile[website] string
    profile[about] string
    profile[signature] string
    privacy[allow_view_profile] string
    privacy[allow_post_profile] string
    privacy[allow_receive_news_feed] string
    privacy[allow_send_personal_conversation] string
    privacy[allow_view_identities] string
    visible bool
    active_visible bool
    timezone string
    custom_title string
    custom_fields[<name>] string

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST me/avatar
    Обновляет аватар текущего пользователя

    Параметры

    Исходные данные Тип Описание
    avatar file Загруженный новый аватар

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    DELETE me/avatar
    Удаляет аватар текущего пользователя

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST me/email
    Обновление адреса электронной почты текущего пользователя

    Параметры

    Исходные данные Тип Описание
    current_password string
    email string

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    confirmation_required bool True, если для этого изменения требуется подтверждение по электронной почте

    POST me/passwords
    Обновление пароля текущего пользователя

    Параметры

    Исходные данные Тип Описание
    current_password string
    new_password string

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true



    Nodes​


    GET nodes/
    Получает дерево узлов

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    tree_map array Связка, соединяющая идентификаторы родительских узлов со списком идентификаторов их дочерних узлов
    nodes Node[] Список всех узлов

    POST nodes/
    Создает новый узел

    Параметры

    Исходные данные Тип Описание
    node[title] string
    node[node_name] string
    node[description] string
    node[parent_node_id] integer
    node[display_order] integer
    node[display_in_list] bool
    type_data array Данные узла, относящиеся к конкретному типу. Доступные опции зависят от типа узла.
    node_type_id string

    Ответ

    Результат Тип Описание
    node Node Информация о созданном узле

    GET nodes/flattened
    Получает сплющенное дерево узлов. При обходе этого дерева будет возвращен список узлов в ожидаемом порядке.

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    nodes_flat array Массив. Каждая запись содержит ключи "node" и "depth".

    GET nodes/{id}
    Получает информацию об указанном узле

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    node Node

    POST nodes/{id}
    Обновляет указанный узел

    Параметры

    Исходные данные Тип Описание
    node[title] string
    node[node_name] string
    node[description] string
    node[parent_node_id] integer
    node[display_order] integer
    node[display_in_list] bool
    type_data array Данные узла, относящиеся к конкретному типу. Доступные опции зависят от типа узла.

    Ответ

    Результат Тип Описание
    node Node Обновленная информация об узле

    DELETE nodes/{id}
    Удаляет указанный узел

    Параметры

    Исходные данные Тип Описание
    delete_children bool Если true, дочерние узлы будут удалены. В противном случае они будут подключены к родителю этого узла.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true



    Posts​


    POST posts/
    Добавляет новый ответ в тему.

    Параметры

    Исходные данные Тип Описание
    thread_id integer ID темы, на которую нужно ответить.
    message string
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть post, а context[thread_id] должен быть установлен на ID этой темы.

    Ответ

    Результат Тип Описание
    null null null

    GET posts/{id}
    Получает информацию об указанном посте

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    post Post

    POST posts/{id}
    Обновляет указанный пост

    Параметры

    Исходные данные Тип Описание
    message string
    silent bool Если true и разрешения позволяют, эта правка не будет обновляться с указанием "последнее редактирование".
    clear_edit bool Если true и разрешения позволяют, все указания на "последнее редактирование" будут удалены. Требуется "silent".
    author_alert bool
    author_alert_reason string
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть post, а context[post_id] должен быть установлен на ID этого поста.

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true
    post Post

    DELETE posts/{id}
    Удаляет указанный пост. По умолчанию - мягкое удаление.

    Параметры

    Исходные данные Тип Описание
    hard_delete bool
    reason string
    author_alert bool
    author_alert_reason string

    Ответ

    Результат Тип Описание
    success bool Результат запроса. Может быть только true

    POST posts/{id}/mark-solution
    Переключить указанное сообщение как решение для содержащей его темы. Если сообщение отмечено как решение, когда другое уже отмечено, существующее решение будет снято.

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    true mixed Success
    new_solution_post Post Пост, который был отмечен как решение
    old_solution_post Post Пост, не отмеченное как решение

    POST posts/{id}/react
    Реагирует на указанный пост

    Параметры

    Исходные данные Тип Описание
    reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.

    Ответ

    Результат Тип Описание
    success true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.

    POST posts/{id}/vote
    Голосует за указанный пост (если применимо)

    Параметры

    Исходные данные Тип Описание
    type string Тип голосования, "up" или "down". Используйте текущий тип для отмены.

    Ответ

    Результат Тип Описание
    success true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.



    Profile posts​


    POST profile-post-comments/
    Создает новый комментарий к сообщению профиля.

    Параметры

    Исходные данные Тип Описание
    profile_post_id integer Идентификатор сообщения профиля, к которому будет прикреплен этот комментарий.
    message string
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post_comment, а context[profile_post_id] должен соответствовать ID сообщения профиля.

    Ответ

    Результат Тип Описание
    success true
    comment ProfilePostComment

    GET profile-post-comments/{id}/
    Получает информацию об указанном комментарии к посту профиля.

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    comment ProfilePostComment

    POST profile-post-comments/{id}/
    Обновляет указанный комментарий к сообщению профиля.

    Параметры

    Исходные данные Тип Описание
    message string
    author_alert bool
    author_alert_reason bool
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post_comment, а context[profile_post_comment_id] должен быть установлен на ID комментария этого сообщения профиля.

    Ответ

    Результат Тип Описание
    success true
    comment ProfilePostComment

    DELETE profile-post-comments/{id}/
    Удаляет указанный комментарий к сообщению профиля. По умолчанию - мягкое удаление.

    Параметры

    Исходные данные Тип Описание
    hard_delete bool
    reason string
    author_alert bool
    author_alert_reason string

    Ответ

    Результат Тип Описание
    success true

    POST profile-post-comments/{id}/react
    Реагирует на указанный комментарий к сообщению профиля

    Параметры

    Исходные данные Тип Описание
    reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.

    Ответ

    Результат Тип Описание
    success true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.

    POST profile-posts/
    Создает новое сообщение профиля.

    Параметры

    Исходные данные Тип Описание
    user_id integer Идентификатор пользователя, в профиле которого будет размещена эта информация.
    message string
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post, а context[profile_user_id] должен быть установлен на данный идентификатор пользователя.

    Ответ

    Результат Тип Описание
    success true
    profile_post ProfilePost

    GET profile-posts/{id}/
    Получает информацию об указанном посте профиля.

    Параметры

    Исходные данные Тип Описание
    with_comments bool Если указано, ответ будет включать страницу комментариев.
    page integer Страница комментариев для включения
    direction string Запрос определенного порядка сортировки комментариев - по умолчанию 'desc' (самые новые первыми), также допускается 'asc' (самые старые первыми)

    Ответ

    Результат Тип Описание
    profile_post ProfilePost
    comments ProfilePostComment[] Список комментариев на запрашиваемой странице
    pagination pagination Сведения о страницах

    POST profile-posts/{id}/
    Обновляет указанный пост профиля.

    Параметры

    Исходные данные Тип Описание
    message string
    author_alert bool
    author_alert_reason bool
    attachment_key string Ключ вложения API для загрузки файлов. Тип контекста ключа вложения должен быть profile_post, а context[profile_post_id] должен быть установлен на ID этого сообщения профиля.

    Ответ

    Результат Тип Описание
    success true
    profile_post ProfilePost

    DELETE profile-posts/{id}/
    Удаляет указанное сообщение профиля. По умолчанию - мягкое удаление.

    Параметры

    Исходные данные Тип Описание
    hard_delete bool
    reason string
    author_alert bool
    author_alert_reason string

    Ответ

    Результат Тип Описание
    success true

    GET profile-posts/{id}/comments
    Получает страницу комментариев к указанному посту профиля.

    Параметры

    Исходные данные Тип Описание
    page integer
    direction string Запрос определенного порядка сортировки комментариев - по умолчанию 'desc' (самые новые первыми), также допускается 'asc' (самые старые первыми)

    Ответ

    Результат Тип Описание
    comments ProfilePostComment[] Список комментариев на запрашиваемой странице
    pagination pagination Сведения о страницах

    POST profile-posts/{id}/react
    Реагирует на указанное сообщение профиля

    Параметры

    Исходные данные Тип Описание
    reaction_id integer Идентификатор реакции для использования. Для отмены используйте идентификатор текущей реакции.

    Ответ

    Результат Тип Описание
    success true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.



    Search forums​


    GET search-forums/{id}/
    Получает информацию об указанном искомом форуме

    Параметры

    Исходные данные Тип Описание
    with_threads bool Если true, получает страницу тем в этом поисковом форуме
    page integer

    Ответ

    Результат Тип Описание
    search_forum SearchForum
    threads Thread[] Темы на этой странице. Примечание: при этом всегда будут соблюдаться разрешения пользователя на просмотр, независимо от того, настроен ли API на обход разрешений.
    pagination pagination Сведения о страницах
    sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.

    GET search-forums/{id}/threads
    Получает страницу тем из указанного искомого форума.

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    threads Thread[] Темы на этой странице. Примечание: при этом всегда будут соблюдаться разрешения пользователя на просмотр, независимо от того, настроен ли API на обход разрешений.
    pagination pagination Сведения о страницах
    sticky Thread[] Если на странице 1, то список закрепленных тем на этом форуме. Не учитывается в лимите на страницу.



    Stats​


    GET stats/
    Получает статистику сайта и общую информацию о активности

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    totals[threads] integer
    totals[messages] integer
    totals[users] integer
    latest_user[user_id] integer
    latest_user[username] string
    latest_user[register_date] integer
    online[total] integer
    online[members] integer
    online[guests] integer



    Threads​


    GET threads/
    Получает список тем.

    Параметры

    Исходные данные Тип Описание
    page integer
    prefix_id integer Фильтрует темы с указанным префиксом.
    starter_id integer Фильтрует темы, начатые указанным идентификатором пользователя.
    last_days integer Фильтрует темы, в которых был получен ответ за последние X дней.
    unread bool Фильтрует только непрочитанные темы. Игнорируется для гостей.
    thread_type string Фильтрует темы указанного типа темы.
    order string Метод сортировки: last_post_date, post_date. В контексте конкретного форума: title, reply_count, view_count, vote_score, first_post_reaction_score.
    direction string Либо "asc", либо "desc" для возрастания или убывания. Применяется, только если указан порядок.

    Ответ

    Результат Тип Описание
    threads Thread[]
    pagination pagination

    POST threads/
    Создает тему. Данные типа темы могут быть заданы с помощью дополнительного ввода, специфичного для целевого типа темы.

    Параметры

    Исходные данные Тип Описание
    node_id integer ID форума, в котором будет создана тема.
    title string Название темы.
    message string Тело первого сообщения в теме.
    discussion_type string Тип темы, которую необходимо создать. Для конкретных типов может потребоваться дополнительный ввод.
    prefix_id integer Идентификатор префикса, применяемого к теме. Если он не действителен в выбранном форуме, то будет проигнорирован.
    tags string[] Массив тегов для применения к теме.
    custom_fields[<name>] string Значение для применения к пользовательскому полю с указанным именем.
    discussion_open bool
    sticky bool
    attachment_key string API-ключ вложения для загрузки файлов. Тип контекста ключа вложения должен быть post с context[node_id], установленным на ID форума, в котором он размещается.

    Ответ

    Результат Тип Описание
    success true
    thread Thread

    Ошибки

    Ошибка Описание
    no_permission No permission error.

    GET threads/{id}/
    Получает информацию об указанной теме.

    Параметры

    Исходные данные Тип Описание
    with_posts bool Если указано, ответ будет включать страницу сообщений.
    page integer Страница сообщений для включения
    with_first_post bool Если указано, ответ будет содержать первое сообщение в теме.
    with_last_post bool Если указано, ответ будет содержать последнее сообщение в теме.
    order string Фильтрует только непрочитанные темы. Игнорируется для гостей.

    Ответ

    Результат Тип Описание
    thread Thread
    first_unread Post Если тема не прочитана, информация о первом непрочитанном сообщении.
    first_post Post По запросу, информация о первом сообщении в теме.
    last_post Post По запросу, информация о последнем сообщении в теме.
    pinned_post Post Прикрепленное первое сообщение темы, если оно определено типом темы.
    highlighted_posts Post[] Список выделенных сообщений, если они соответствуют типу темы. Причина выделения зависит от типа темы.
    posts Post[] Список сообщений на запрашиваемой странице. Обратите внимание, что даже если первое сообщение прикреплено, оно будет включено сюда.
    pagination pagination Сведения о страницах

    POST threads/{id}/
    Обновляет указанную тему

    Параметры

    Исходные данные Тип Описание
    prefix_id integer
    title string
    discussion_open bool
    sticky bool
    custom_fields[<name>] string
    add_tags array
    remove_tags array

    Ответ

    Результат Тип Описание
    success true
    thread Thread

    DELETE threads/{id}/
    Удаляет указанную тему. По умолчанию - мягкое удаление.

    Параметры

    Исходные данные Тип Описание
    hard_delete bool
    reason string
    starter_alert bool
    starter_alert_reason string

    Ответ

    Результат Тип Описание
    success true

    POST threads/{id}/change-type
    Преобразует тему в указанный тип. Дополнительные данные типа темы могут быть заданы с помощью ввода, специфичного для нового типа темы.

    Параметры

    Исходные данные Тип Описание
    new_thread_type_id string

    Ответ

    Результат Тип Описание
    success true
    thread Thread

    POST threads/{id}/mark-read
    Помечает тему как прочитанную до указанного времени. При этом нельзя пометить тему как непрочитанную

    Параметры

    Исходные данные Тип Описание
    date integer Временная метка Unix для отметки прочтения темы. Если не указано, по умолчанию используется текущее время.

    Ответ

    Результат Тип Описание
    success true

    POST threads/{id}/move
    Перемещает указанную тему в другой форум. Одновременно поддерживаются только простые обновления заголовка/префикса

    Параметры

    Исходные данные Тип Описание
    target_node_id integer
    prefix_id integer Если задано, обновляет префикс темы. Префикс должен быть действительным в целевом форуме.
    title string Если установлено, обновляет заголовок темы
    notify_watchers bool Если true, пользователи, просматривающие целевой форум, получат уведомление, как если бы эта тема была создана в целевом форуме.
    starter_alert bool Если true, то создатель темы получит уведомление о перемещении.
    starter_alert_reason bool

    Ответ

    Результат Тип Описание
    success true
    thread Thread

    GET threads/{id}/posts
    Получает страницу сообщений в указанной теме.

    Параметры

    Исходные данные Тип Описание
    page integer
    order string Запрос определенного порядка сортировки сообщений из доступных вариантов для типа темы

    Ответ

    Результат Тип Описание
    pinned_post Post Прикрепленное первое сообщение темы, если оно определено типом темы.
    highlighted_posts Post[] Список выделенных сообщений, если они соответствуют типу темы. Причина выделения зависит от типа темы.
    posts Post[] Список сообщений на запрашиваемой странице. Обратите внимание, что даже если первое сообщение прикреплено, оно будет включено сюда.
    pagination pagination Сведения о страницах

    POST threads/{id}/vote
    Голосование в указанной теме (если применимо)

    Параметры

    Исходные данные Тип Описание
    type string Тип голосования, "up" или "down". Используйте текущий тип для отмены.

    Ответ

    Результат Тип Описание
    success true
    action string "insert" или "delete" в зависимости от того, была ли реакция добавлена или удалена.



    Users​


    GET users/
    Получает список пользователей (в алфавитном порядке)

    Параметры

    Исходные данные Тип Описание
    page integer

    Ответ

    Результат Тип Описание
    users User[]
    pagination pagination

    POST users/
    Создает пользователя.

    Параметры

    Исходные данные Тип Описание
    option[creation_watch_state] string
    option[interaction_watch_state] string
    option[content_show_signature] bool
    option[email_on_conversation] bool
    option[push_on_conversation] bool
    option[receive_admin_email] bool
    option[show_dob_year] bool
    option[show_dob_date] bool
    profile[location] string
    profile[website] string
    profile[about] string
    profile[signature] string
    privacy[allow_view_profile] string
    privacy[allow_post_profile] string
    privacy[allow_receive_news_feed] string
    privacy[allow_send_personal_conversation] string
    privacy[allow_view_identities] string
    visible bool
    activity_visible bool
    timezone string
    custom_title string
    option[is_discouraged] bool
    username string
    email string
    user_group_id integer
    secondary_group_ids integer[]
    user_state string
    is_staff bool
    message_count integer
    reaction_score integer
    trophy_points integer
    username_change_visible bool Если значение true и имя пользователя изменено, изменение будет заметно (показано в публичном списке предыдущих имен пользователей).
    password string
    dob[day] integer
    dob[month] integer
    dob[year] integer
    custom_fields[<name>] string

    Ответ

    Результат Тип Описание
    success true
    user User

    GET users/find-email
    Находит пользователей по их электронной почте. Доступно только для пользователей-администраторов (или при обходе разрешений).

    Параметры

    Исходные данные Тип Описание
    email string [required]

    Ответ

    Результат Тип Описание
    user User Пользователь, точно соответствующий заданному электронному адресу

    GET users/find-name
    Находит пользователей по префиксу их имени пользователя.

    Параметры

    Исходные данные Тип Описание
    username string

    Ответ

    Результат Тип Описание
    exact User Пользователь, который точно соответствует заданному имени пользователя
    recommendations User[] Список пользователей, которые соответствуют префиксу имени пользователя (но не точно)

    GET users/{id}/
    Получает информацию об указанном пользователе.

    Параметры

    Исходные данные Тип Описание
    with_posts bool Если указано, ответ будет включать страницу сообщений профиля.
    page integer Страница комментариев для включения

    Ответ

    Результат Тип Описание
    user User
    profile_posts ProfilePost[] Список постов профиля на запрашиваемой странице
    pagination pagination Сведения о страницах

    POST users/{id}/
    Обновляет существующего пользователя.

    Параметры

    Исходные данные Тип Описание
    option[creation_watch_state] string
    option[interaction_watch_state] string
    option[content_show_signature] bool
    option[email_on_conversation] bool
    option[push_on_conversation] bool
    option[receive_admin_email] bool
    option[show_dob_year] bool
    option[show_dob_date] bool
    profile[location] string
    profile[website] string
    profile[about] string
    profile[signature] string
    privacy[allow_view_profile] string
    privacy[allow_post_profile] string
    privacy[allow_receive_news_feed] string
    privacy[allow_send_personal_conversation] string
    privacy[allow_view_identities] string
    visible bool
    activity_visible bool
    timezone string
    custom_title string
    option[is_discouraged] bool
    username string
    email string
    user_group_id integer
    secondary_group_ids integer[]
    user_state string
    is_staff bool
    message_count integer
    reaction_score integer
    trophy_points integer
    username_change_visible bool Если значение true и имя пользователя изменено, изменение будет заметно (показано в публичном списке предыдущих имен пользователей).
    password string
    dob[day] integer
    dob[month] integer
    dob[year] integer
    custom_fields[<name>] string

    Ответ

    Результат Тип Описание
    success true
    user User

    DELETE users/{id}/
    Удаляет указанного пользователя

    Параметры

    Исходные данные Тип Описание
    rename_to string Если указано, пользователь будет переименован перед удалением

    Ответ

    Результат Тип Описание
    success true

    POST users/{id}/avatar
    Обновляет аватар указанного пользователя

    Параметры

    Исходные данные Тип Описание
    avatar file Загруженный новый аватар

    Ответ

    Результат Тип Описание
    success true

    DELETE users/{id}/avatar
    Удаляет аватар указанного пользователя

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    success true

    GET users/{id}/profile-posts
    Получает страницу сообщений профиля указанного пользователя.

    Параметры

    Исходные данные Тип Описание
    page integer

    Ответ

    Результат Тип Описание
    profile_posts ProfilePost[] Список постов профиля на запрашиваемой странице
    pagination pagination Сведения о страницах



    resource-categories​


    DELETE resource-categories/{id}/
    Deletes the specified category

    Параметры

    Исходные данные Тип Описание
    delete_children bool If true, child nodes will be deleted. Otherwise, they will be connected to this node's parent.

    Ответ

    Результат Тип Описание
    success true

    GET resource-categories/{id}/content
    Gets a page of resources from the specified category.

    Параметры

    Исходные данные Тип Описание
    null null null

    Ответ

    Результат Тип Описание
    resources ResourceItem[] Resources on this page
    pagination pagination Pagination information
Сверху Снизу