REST API модуля «Главная страница»
Справочник REST-методов модуля ithive.homepage для интеграций, входящих вебхуков и AI-агентов.
Базовый URL
https://{портал}/rest/{user_id}/{webhook_code}/{method}.json
Пример:
https://portal.company.ru/rest/1/xxxxxxxx/homepage.content.list.json
Scope и аутентификация
- Scope:
homepage - Аутентификация: входящий вебхук Bitrix24 или сессия авторизованного пользователя
- Почти все методы требуют авторизации
- Для административных методов пользователь должен быть администратором портала или иметь требуемые права на инфоблок
Формат ответа
| Поле | Описание |
|---|---|
result |
Данные или null при ошибке |
total |
Количество записей для list-методов |
next |
Смещение следующей страницы |
error |
null или { code, message, details } |
Пагинация
Для list-методов:
| Параметр | По умолчанию | Описание |
|---|---|---|
limit |
50 | Максимум 500 |
offset |
0 | Смещение |
fetchAll |
false | Вернуть все страницы; лимит по умолчанию 5000 |
Фильтрация
Поддерживается Mongo-стиль фильтров:
- Операторы:
$eq,$ne,$gt,$gte,$lt,$lte,$in,$nin - Фильтр можно передавать как JSON-строку в query или как объект
- Поддерживаемые поля зависят от метода и описаны на странице соответствующего раздела
Разделы REST-справочника
| Раздел | Описание |
|---|---|
| Служебные / AI-endpoint'ы | homepage.currentUser, homepage.schema, homepage.batch |
| Просмотры новостей | homepage.newsviews.* |
| Контент главной | homepage.content.* |
| Раздел «О компании» | homepage.about.* |
| Новости и комментарии | homepage.news.* |
| Виджеты | homepage.widgets.* |
| Меню | homepage.menu.* |
| Конфиг | homepage.config.* |
Связанные материалы
Предыдущая
Следующая