> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arzguard.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Guard Forum API

> API форума Arizona Guard: темы, сообщения, профили, личные диалоги и инструменты интеграции.

Guard Forum API позволяет подключить форум Arizona Guard к вашему приложению, боту или внутреннему сервису. Через API можно работать с разделами, темами и сообщениями, получать сведения о пользователях, управлять диалогами и уведомлениями, а также использовать дополнения форума.

Справочник описывает доступные методы **XenForo 2.2.19** и расширений Guard Forum: **69 стандартных методов и 4 метода дополнений**. Методы сгруппированы по назначению; у каждого указаны параметры, результат и требования к доступу.

> **[Сделать первый запрос](/guard-forum/quickstart)**
>
> Настройте доступ к API и получите список тем.

> **[Каталог методов](/guard-forum/catalog)**
>
> Найдите нужную операцию среди стандартных методов и дополнений.

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

| Область | Возможности |
| - | - |
| Разделы и темы | Чтение разделов, списки тем, публикация, редактирование, перенос и отметки прочтения |
| Сообщения | Ответы в темах, редактирование, реакции, голоса и отметка решения |
| Профили | Чтение профиля пользователя по ID; настройки и аватар текущего пользователя |
| Профильные записи | Публикации в профиле, комментарии и реакции |
| Личные диалоги | Участники, сообщения, приглашения, избранное и состояние прочтения |
| Уведомления и вложения | Чтение и создание уведомлений, загрузка и получение файлов |
| Повышение и снятие | Доступные инициатору группы и изменение дополнительных групп пользователя |

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

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

```text theme={null}
https://forum.arzguard.com/api/
```

Каждый запрос должен содержать заголовок `XF-Api-Key`. Для ключей Super user пользовательский контекст выбирается через `XF-Api-User`; без него запрос выполняется в контексте гостя.

```bash Пример запроса на чтение theme={null}
curl --silent --show-error \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  --header 'Accept: application/json' \
  'https://forum.arzguard.com/api/threads/?page=1'
```

`FORUM_API_KEY` — переменная окружения вашей серверной интеграции. Реальный ключ не должен попадать в браузерный код, URL или публичные логи.

> [!NOTE]
>
> 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»](/guard-forum/extensions).

> **[Авторизация](/guard-forum/authentication)**
>
> Типы ключей, scopes и пользовательский контекст.

> **[Запросы и ошибки](/guard-forum/requests-and-errors)**
>
> Кодирование параметров, HTTP-статусы и обработка ошибок.

> **[Схемы данных](/guard-forum/models)**
>
> User, темы, сообщения, разделы и другие объекты.

> **[Особенности форума](/guard-forum/extensions)**
>
> Собственные методы и расширения стандартных объектов.


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