Skip to main content
Guard Forum API позволяет подключить форум Arizona Guard к вашему приложению, боту или внутреннему сервису. Через API можно работать с разделами, темами и сообщениями, получать сведения о пользователях, управлять диалогами и уведомлениями, а также использовать дополнения форума. Справочник описывает доступные методы XenForo 2.2.19 и расширений Guard Forum: 69 стандартных методов и 4 метода дополнений. Методы сгруппированы по назначению; у каждого указаны параметры, результат и требования к доступу.

Сделать первый запрос

Настройте доступ к API и получите список тем.

Каталог методов

Найдите нужную операцию среди стандартных методов и дополнений.

​
Возможности API

Доступные операции зависят от scopes ключа, прав выбранного пользователя и настроек соответствующего раздела или дополнения. Наличие метода в справочнике не означает, что он разрешён любому ключу.

​
Адрес и авторизация

Каждый запрос должен содержать заголовок XF-Api-Key. Для ключей Super user пользовательский контекст выбирается через XF-Api-User; без него запрос выполняется в контексте гостя.
Пример запроса на чтение
FORUM_API_KEY — переменная окружения вашей серверной интеграции. Реальный ключ не должен попадать в браузерный код, URL или публичные логи.
Scopes ключа и права пользователя проверяются отдельно. Например, thread:read разрешает обращаться к методам тем, но сам по себе не открывает закрытые разделы.

​
Формат взаимодействия

Обычный ответ API — JSON. Параметры GET передаются в URL, а тело запроса записи — как application/x-www-form-urlencoded. Для загрузки файлов используется multipart/form-data. Списки могут быть постраничными; ориентируйтесь на описание метода и объект pagination. Даты Unix timestamp передаются в секундах. Вложенные объекты и отдельные поля зависят от контекста, прав и запрошенной детализации.

​
Дополнения Guard Forum

Дополнение Promote/Demote добавляет методы повышения и снятия. MultiPrefix расширяет работу с префиксами тем, а TimeSpentOnline добавляет время активности в объект пользователя. Для этих возможностей справочник учитывает фактическое поведение установленной версии, включая особенности фильтров, формата данных и проверки доступа. Подробнее — «Особенности Guard Forum».

Авторизация

Типы ключей, scopes и пользовательский контекст.

Запросы и ошибки

Кодирование параметров, HTTP-статусы и обработка ошибок.

Схемы данных

User, темы, сообщения, разделы и другие объекты.

Особенности форума

Собственные методы и расширения стандартных объектов.