Первый запрос к Guard Forum

Для работы понадобится API-ключ, выданный администратором форума. Храните его в серверном окружении как FORUM_API_KEY. Все примеры ниже выполняют чтение и не требуют создавать тестовые публикации или пользователей.

Подготовьте ключ

Для чтения списка тем ключу нужен scope thread:read. Сохраните выданный ключ в переменной окружения FORUM_API_KEY на сервере интеграции.Scopes определяют доступные методы, а права пользователя — доступные данные. Убедитесь, что выбранный контекст может читать нужные темы.

Определите пользователя запроса

У Guest key контекст гостевой, а User key закреплён за пользователем. Для Super user key без заголовка XF-Api-User также используется гость.Если интеграции нужен выбранный пользователь, добавьте заголовок с его ID. В примере 123 — условное значение:

XF-Api-User: 123

Выбор пользователя относится только к Super user key. Подробности — в разделе «Авторизация».

Получите список тем

Запросите первую страницу тем. Ответ учитывает права пользовательского контекста; закрытые для него темы в выдачу не попадут.

curl --silent --show-error \
  --header "XF-Api-Key: $FORUM_API_KEY" \
  'https://forum.arzguard.com/api/threads/?page=1'

Результат содержит массив threads с темами и объект pagination с данными текущей страницы. Подробные параметры и фильтры — у метода «Список тем».

Запрос на Node.js

Код предназначен для Node.js с поддержкой fetch и AbortSignal.timeout. Он не выводит ключ или содержимое профилей пользователей.

const apiKey = process.env.FORUM_API_KEY;
if (!apiKey) throw new Error('Не задана FORUM_API_KEY');

const response = await fetch('https://forum.arzguard.com/api/threads/?page=1', {
  headers: {
    'XF-Api-Key': apiKey,
    Accept: 'application/json',
  },
  signal: AbortSignal.timeout(15_000),
  redirect: 'error',
});

let data;
try {
  data = await response.json();
} catch {
  throw new Error(`HTTP ${response.status}: ответ не в формате JSON`);
}

if (!response.ok) {
  const codes = Array.isArray(data.errors)
    ? data.errors.map(error => error.code).join(', ')
    : 'unknown_error';
  throw new Error(`HTTP ${response.status}: ${codes}`);
}

console.log(`Тем на странице: ${data.threads.length}`);

Таймаут в 15 секунд выбран для примера, а не является ограничением сервиса.

Следующий шаг

Выберите ресурс в каталоге методов. Перед вызовом проверьте HTTP-метод, scopes, обязательные параметры и пользовательские права. Для операций записи используйте тело формы, а не JSON.

Каталог API

Темы, сообщения, профили, диалоги и другие возможности API.

Ошибки и пагинация

Обработайте неуспешный ответ и постраничную выдачу.

Общая информация

Guard Forum

Kalenich Stats

Первый запрос к Guard Forum

Запрос на Node.js

Следующий шаг

Каталог API

Ошибки и пагинация

​Запрос на Node.js

​Следующий шаг

Каталог API

Ошибки и пагинация

Запрос на Node.js

Следующий шаг