curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/search-forums/123/?with_threads=1&page=1'
{
"search_forum": {
"node_id": 123
},
"threads": [
{
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Поисковые разделы
Получить поисковый раздел
Возвращает поисковый раздел и, по запросу, страницу его тем.
GET
/
api
/
search-forums
/
{id}
/
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/search-forums/123/?with_threads=1&page=1'
{
"search_forum": {
"node_id": 123
},
"threads": [
{
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}
Возвращает поисковый раздел и, по запросу, страницу его тем.
Обязательные scopes:
Доступ
В каждом запросе обязателен заголовокXF-Api-Key. Примеры используют серверную переменную $FORUM_API_KEY; тип ключа и контекст пользователя определяют доступ к данным.
string
required
Ключ API. Храните его на сервере интеграции; в примере используется переменная окружения.
node:read.
При with_threads=1 дополнительно требуется thread:read.
Особенности
Это чтение настроенного поискового раздела XenForo 2.2, а не произвольный полнотекстовый поиск. Темы выбираются из пользовательского кэша раздела и всегда учитывают права просмотра текущего пользователя.Параметры
integer
required
ID раздела. Значение
123 в примере условное.boolean
При
1 включает страницу тем вместе с информацией о разделе. Фильтры и сортировка тем действуют только при включении этой выдачи.integer
Номер страницы. По умолчанию запрашивается первая страница; размер выдачи определяется настройками форума.
Успешный ответ
HTTP200. Пример ниже сокращён и содержит только условные данные. Полные объекты и условия видимости полей описаны в схемах данных.
| Поле | Тип | Описание |
|---|---|---|
search_forum | SearchForum | Объект настроенного поискового раздела SearchForum. |
threads | Thread[] | Темы запрошенной страницы. Проверка видимости текущего пользователя сохраняется даже при обходе прав API. Возвращается только при with_threads=1. |
pagination | pagination | Метаданные страницы: current_page, last_page, per_page, shown, total. Размер страницы определяется настройками форума. Возвращается только при with_threads=1. |
Ошибки
Стандартный ответ содержит массивerrors с code, message и params. Проверяйте HTTP-статус и машинный код; формат и обработка ошибок общие для API.
curl --request GET \
--header "XF-Api-Key: $FORUM_API_KEY" \
--header 'Accept: application/json' \
'https://forum.arzguard.com/api/search-forums/123/?with_threads=1&page=1'
{
"search_forum": {
"node_id": 123
},
"threads": [
{
"thread_id": 123,
"sv_prefix_ids": [
1
]
}
],
"pagination": {
"current_page": 1,
"last_page": 1,
"per_page": 20,
"shown": 1,
"total": 1
}
}