# Guard API

> Документация по API продуктов Guard

- [Об API продуктов Guard](https://docs.arzguard.com/ob-api-produktov-guard/overview.md)
- [Guard Forum API](https://docs.arzguard.com/guard-forum/overview.md): API форума Arizona Guard: темы, сообщения, профили, личные диалоги и инструменты интеграции.
- [Первый запрос к Guard Forum](https://docs.arzguard.com/guard-forum/quickstart.md): Настройте доступ к API форума и получите список тем.
- [Авторизация и права доступа](https://docs.arzguard.com/guard-forum/authentication.md): Типы ключей XenForo, заголовки авторизации, пользовательский контекст и области доступа к API Guard Forum.
- [Запросы, ответы и ошибки](https://docs.arzguard.com/guard-forum/requests-and-errors.md): Базовый URL Guard Forum, форматы тела запроса, JSON-ответы, HTTP-статусы и обработка ошибок XenForo.
- [Каталог методов](https://docs.arzguard.com/guard-forum/catalog.md): 73 доступных метода API Guard Forum: стандартные ресурсы XenForo и дополнения Guard.
- [Особенности Guard Forum](https://docs.arzguard.com/guard-forum/extensions.md): Собственные методы, дополнительные поля пользователей и тем, совместимость и ограничения установленных дополнений.
- [Получить раздел](https://docs.arzguard.com/guard-forum/api/get-forums-id.md): Информация о разделе с необязательной страницей тем.
- [Отметить раздел прочитанным](https://docs.arzguard.com/guard-forum/api/post-forums-id-mark-read.md): Переносит отметку прочтения раздела до указанного момента.
- [Темы раздела](https://docs.arzguard.com/guard-forum/api/get-forums-id-threads.md): Страница тем раздела с фильтрами, сортировкой и закреплёнными темами.
- [Получить поисковый раздел](https://docs.arzguard.com/guard-forum/api/get-search-forums-id.md): Возвращает поисковый раздел и, по запросу, страницу его тем.
- [Темы поискового раздела](https://docs.arzguard.com/guard-forum/api/get-search-forums-id-threads.md): Возвращает страницу тем из настроенного поискового раздела.
- [Список тем](https://docs.arzguard.com/guard-forum/api/get-threads.md): Постраничный список доступных тем с фильтрами и сортировкой.
- [Создать тему](https://docs.arzguard.com/guard-forum/api/post-threads.md): Создаёт тему и первое сообщение в выбранном разделе.
- [Получить тему](https://docs.arzguard.com/guard-forum/api/get-threads-id.md): Информация о теме, связанных сообщениях и необязательной странице ответов.
- [Изменить тему](https://docs.arzguard.com/guard-forum/api/post-threads-id.md): Редактирует заголовок, префиксы, состояние, теги и пользовательские поля темы.
- [Удалить тему](https://docs.arzguard.com/guard-forum/api/delete-threads-id.md): Удаляет тему мягко или, с дополнительным scope, окончательно.
- [Изменить тип темы](https://docs.arzguard.com/guard-forum/api/post-threads-id-change-type.md): Преобразует тему в другой допустимый тип обсуждения.
- [Отметить тему прочитанной](https://docs.arzguard.com/guard-forum/api/post-threads-id-mark-read.md): Переносит отметку прочтения темы до выбранного момента.
- [Переместить тему](https://docs.arzguard.com/guard-forum/api/post-threads-id-move.md): Перемещает тему в другой раздел с необязательным изменением заголовка и префикса.
- [Сообщения темы](https://docs.arzguard.com/guard-forum/api/get-threads-id-posts.md): Возвращает страницу сообщений темы с данными о закреплённых и выделенных сообщениях.
- [Голос за тему](https://docs.arzguard.com/guard-forum/api/post-threads-id-vote.md): Добавляет или снимает голос за тему, если её тип поддерживает голосование.
- [Ответить в теме](https://docs.arzguard.com/guard-forum/api/post-posts.md): Создаёт сообщение в существующей теме.
- [Получить сообщение](https://docs.arzguard.com/guard-forum/api/get-posts-id.md): Возвращает сообщение и доступные сведения о нём.
- [Изменить сообщение](https://docs.arzguard.com/guard-forum/api/post-posts-id.md): Редактирует текст, вложения и отметку редактирования сообщения.
- [Удалить сообщение](https://docs.arzguard.com/guard-forum/api/delete-posts-id.md): Удаляет сообщение: по умолчанию мягко, с отдельным флагом — окончательно.
- [Переключить отметку решения](https://docs.arzguard.com/guard-forum/api/post-posts-id-mark-solution.md): Помечает сообщение решением вопроса или снимает существующую отметку.
- [Реакция на сообщение](https://docs.arzguard.com/guard-forum/api/post-posts-id-react.md): Добавляет, изменяет или снимает реакцию текущего пользователя.
- [Голос за сообщение](https://docs.arzguard.com/guard-forum/api/post-posts-id-vote.md): Добавляет или снимает голос за сообщение, если его тип поддерживает голосование.
- [Получить пользователя](https://docs.arzguard.com/guard-forum/api/get-users-id.md): Возвращает профиль пользователя и, по запросу, страницу записей профиля.
- [Получить текущего пользователя](https://docs.arzguard.com/guard-forum/api/get-me.md): Возвращает пользователя, в контексте которого выполняется API-запрос.
- [Изменить свой профиль](https://docs.arzguard.com/guard-forum/api/post-me.md): Обновляет доступные настройки профиля текущего пользователя.
- [Загрузить свой аватар](https://docs.arzguard.com/guard-forum/api/post-me-avatar.md): Заменяет аватар текущего пользователя переданным файлом.
- [Удалить свой аватар](https://docs.arzguard.com/guard-forum/api/delete-me-avatar.md): Удаляет установленный аватар текущего пользователя.
- [Изменить свой email](https://docs.arzguard.com/guard-forum/api/post-me-email.md): Меняет email текущего пользователя после проверки его действующего пароля.
- [Изменить свой пароль](https://docs.arzguard.com/guard-forum/api/post-me-password.md): Меняет пароль текущего пользователя после проверки действующего пароля.
- [Добавить комментарий профиля](https://docs.arzguard.com/guard-forum/api/post-profile-post-comments.md): Создаёт комментарий к существующей записи в профиле.
- [Получить комментарий профиля](https://docs.arzguard.com/guard-forum/api/get-profile-post-comments-id.md): Возвращает отдельный комментарий к записи в профиле.
- [Изменить комментарий профиля](https://docs.arzguard.com/guard-forum/api/post-profile-post-comments-id.md): Редактирует комментарий, его вложения и уведомление автору.
- [Удалить комментарий профиля](https://docs.arzguard.com/guard-forum/api/delete-profile-post-comments-id.md): Удаляет комментарий к записи в профиле мягко или окончательно.
- [Реакция на комментарий профиля](https://docs.arzguard.com/guard-forum/api/post-profile-post-comments-id-react.md): Добавляет или снимает реакцию на комментарий к записи в профиле.
- [Создать запись в профиле](https://docs.arzguard.com/guard-forum/api/post-profile-posts.md): Публикует запись в профиле указанного пользователя.
- [Получить запись профиля](https://docs.arzguard.com/guard-forum/api/get-profile-posts-id.md): Возвращает запись профиля с необязательной страницей комментариев.
- [Изменить запись профиля](https://docs.arzguard.com/guard-forum/api/post-profile-posts-id.md): Редактирует запись профиля, вложения и уведомление автору.
- [Удалить запись профиля](https://docs.arzguard.com/guard-forum/api/delete-profile-posts-id.md): Удаляет запись профиля: по умолчанию мягко.
- [Комментарии записи профиля](https://docs.arzguard.com/guard-forum/api/get-profile-posts-id-comments.md): Страница комментариев к записи профиля в выбранном порядке.
- [Реакция на запись профиля](https://docs.arzguard.com/guard-forum/api/post-profile-posts-id-react.md): Добавляет или снимает реакцию на запись в профиле.
- [Ответить в переписке](https://docs.arzguard.com/guard-forum/api/post-conversation-messages.md): Добавляет сообщение в существующую личную переписку.
- [Получить сообщение переписки](https://docs.arzguard.com/guard-forum/api/get-conversation-messages-id.md): Возвращает доступное сообщение личной переписки.
- [Изменить сообщение переписки](https://docs.arzguard.com/guard-forum/api/post-conversation-messages-id.md): Обновляет текст или вложения доступного сообщения.
- [Поставить реакцию на сообщение](https://docs.arzguard.com/guard-forum/api/post-conversation-messages-id-react.md): Добавляет реакцию к сообщению или убирает повторно указанную реакцию.
- [Получить список переписок](https://docs.arzguard.com/guard-forum/api/get-conversations.md): Возвращает личные переписки текущего пользователя с фильтрами и пагинацией.
- [Создать переписку](https://docs.arzguard.com/guard-forum/api/post-conversations.md): Создаёт личную переписку и её первое сообщение для выбранных получателей.
- [Получить переписку](https://docs.arzguard.com/guard-forum/api/get-conversations-id.md): Возвращает сведения о переписке и при необходимости страницу её сообщений.
- [Изменить переписку](https://docs.arzguard.com/guard-forum/api/post-conversations-id.md): Обновляет заголовок и настройки существующей личной переписки.
- [Убрать переписку из списка](https://docs.arzguard.com/guard-forum/api/delete-conversations-id.md): Убирает переписку из списка текущего пользователя, сохраняя её для остальных участников.
- [Пригласить в переписку](https://docs.arzguard.com/guard-forum/api/post-conversations-id-invite.md): Добавляет выбранных пользователей в личную переписку.
- [Отметить переписку прочитанной](https://docs.arzguard.com/guard-forum/api/post-conversations-id-mark-read.md): Продвигает дату прочтения переписки до указанного момента.
- [Отметить переписку непрочитанной](https://docs.arzguard.com/guard-forum/api/post-conversations-id-mark-unread.md): Сбрасывает состояние прочтения всех сообщений переписки для текущего пользователя.
- [Получить сообщения переписки](https://docs.arzguard.com/guard-forum/api/get-conversations-id-messages.md): Возвращает страницу сообщений доступной личной переписки.
- [Изменить отметку избранного](https://docs.arzguard.com/guard-forum/api/post-conversations-id-star.md): Устанавливает или переключает отметку избранного у переписки.
- [Получить уведомления](https://docs.arzguard.com/guard-forum/api/get-alerts.md): Возвращает уведомления пользователя с фильтрами и пагинацией.
- [Отправить уведомление](https://docs.arzguard.com/guard-forum/api/post-alerts.md): Создаёт уведомление для выбранного пользователя через Super key.
- [Отметить все уведомления](https://docs.arzguard.com/guard-forum/api/post-alerts-mark-all.md): Помечает все уведомления текущего пользователя просмотренными или прочитанными.
- [Получить уведомление](https://docs.arzguard.com/guard-forum/api/get-alerts-id.md): Возвращает одно доступное уведомление по его идентификатору.
- [Изменить отметку уведомления](https://docs.arzguard.com/guard-forum/api/post-alerts-id-mark.md): Меняет состояние просмотра или прочтения одного уведомления.
- [Получить временные вложения](https://docs.arzguard.com/guard-forum/api/get-attachments.md): Возвращает ещё не прикреплённые к контенту файлы по ключу загрузки.
- [Загрузить вложение](https://docs.arzguard.com/guard-forum/api/post-attachments.md): Загружает файл в набор вложений, связанный с ранее созданным ключом.
- [Создать ключ вложений](https://docs.arzguard.com/guard-forum/api/post-attachments-new-key.md): Создаёт набор временных вложений для будущего сообщения или другого контента.
- [Получить данные о вложении](https://docs.arzguard.com/guard-forum/api/get-attachments-id.md): Возвращает описание доступного вложения без скачивания его содержимого.
- [Удалить вложение](https://docs.arzguard.com/guard-forum/api/delete-attachments-id.md): Удаляет доступное вложение с учётом прав на его содержимое.
- [Скачать вложение](https://docs.arzguard.com/guard-forum/api/get-attachments-id-data.md): Возвращает содержимое вложения в бинарном виде.
- [Получить адрес миниатюры](https://docs.arzguard.com/guard-forum/api/get-attachments-id-thumbnail.md): Перенаправляет на миниатюру вложения с помощью ответа HTTP 301.
- [Проверить логин и пароль](https://docs.arzguard.com/guard-forum/api/post-auth.md): Проверяет учётные данные и возвращает пользователя при успешной проверке.
- [Определить пользователя по сессии](https://docs.arzguard.com/guard-forum/api/post-auth-from-session.md): Ищет пользователя по идентификатору сессии или значению cookie запоминания входа.
- [Создать ссылку для входа](https://docs.arzguard.com/guard-forum/api/post-auth-login-token.md): Создаёт ограниченный по времени токен и URL входа в указанный аккаунт.
- [Повышение: доступные группы](https://docs.arzguard.com/guard-forum/api/get-promote-user_id.md): Возвращает группы, которыми текущий пользователь вправе управлять через Promote API.
- [Снятие: доступные группы](https://docs.arzguard.com/guard-forum/api/get-demote-user_id.md): Возвращает группы, которыми текущий пользователь вправе управлять через Promote API.
- [Повысить пользователя](https://docs.arzguard.com/guard-forum/api/post-promote-user_id.md): Заменяет управляемые инициатором дополнительные группы одной выбранной группой.
- [Снять группу у пользователя](https://docs.arzguard.com/guard-forum/api/post-demote-user_id.md): Удаляет одну доступную инициатору дополнительную группу у форумного пользователя.
- [Схемы данных](https://docs.arzguard.com/guard-forum/models.md): Типы объектов Guard Forum API, условные поля, пагинация, время и связи между ресурсами.
- [Объект User](https://docs.arzguard.com/guard-forum/models/users.md): Поля, типы и условия видимости объектов: User, UserField.
- [Темы, сообщения и опросы](https://docs.arzguard.com/guard-forum/models/content.md): Поля, типы и условия видимости объектов: Thread, Post, Poll, ThreadPrefix, ThreadField.
- [Разделы форума](https://docs.arzguard.com/guard-forum/models/nodes.md): Поля, типы и условия видимости объектов: Node, Forum, SearchForum, LinkForum, Page.
- [Записи профиля](https://docs.arzguard.com/guard-forum/models/profile.md): Поля, типы и условия видимости объектов: ProfilePost, ProfilePostComment.
- [Диалоги и уведомления](https://docs.arzguard.com/guard-forum/models/conversations.md): Поля, типы и условия видимости объектов: Conversation, ConversationMessage, UserAlert.
- [Вложения](https://docs.arzguard.com/guard-forum/models/attachments.md): Поля, типы и условия видимости объектов: Attachment.
- [Kalenich Stats](https://docs.arzguard.com/kalenich-stats/overview.md): Статистика активности Discord-серверов: от наглядной сводки до интеграции с вашим приложением.
- [Первый запрос](https://docs.arzguard.com/kalenich-stats/quickstart.md): Получите статистику сервера, проверьте состояние отчёта и подготовьте интеграцию.
- [Получить статистику](https://docs.arzguard.com/kalenich-stats/statistics.md): Счётчики сообщений по серверам и каналам за месяц, день, семь дней или диапазон дат.
- [Получить иконки и баннеры](https://docs.arzguard.com/kalenich-stats/icons.md): Текущие изображения Discord-серверов независимо от наличия статистических отчётов.
- [Периоды и границы дат](https://docs.arzguard.com/kalenich-stats/periods.md): Как запросить месяц, день, последние семь дней или собственный диапазон и правильно обработать календарные границы.
- [Данные и статусы отчётов](https://docs.arzguard.com/kalenich-stats/data-and-statuses.md): Структура ответов, схема сервера и канала, полнота общей суммы, свежесть отчётов и метаданные изображений.
- [Ошибки и ограничения API](https://docs.arzguard.com/kalenich-stats/errors.md): Коды ошибок, различие между HTTP-сбоем и состоянием отчёта, CORS и обработка ответов прокси.
- [Примеры интеграции](https://docs.arzguard.com/kalenich-stats/examples.md): Серверные запросы на JavaScript и Python, обработка ошибок и рейтинг по актуальным отчётам.

## Optional

- [Discord сервер](https://discord.gg/arzguard)
- [Telegram канал](https://t.me/arzguard)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.