REST API модуля «Интерактивные подсказки»
Справочник REST-методов модуля ithive.hints для интеграций, входящих вебхуков и AI-агентов.
Базовый URL
https://{портал}/rest/{user_id}/{webhook_code}/{method}.json
Пример (тестовый стенд):
https://76592.dev.wehive.digital/rest/1/{webhook_code}/hints.page.list.json
Scope и аутентификация
- Scope:
hints - Аутентификация: входящий вебхук Bitrix24 или OAuth/сессия авторизованного пользователя
- Все методы
hints.*требуют авторизованного пользователя REST. Без авторизации —UNAUTHORIZED(HTTP 401).
Права доступа
Права задаются настройками модуля и групповыми правами на ithive.hints (N / R / W). Модуль должен быть включён (switchOn=Y на текущем сайте), кроме hints.config.update.
| Уровень | Проверка в коде | Кто может |
|---|---|---|
| Чтение | RestAccess::requireRead() |
Модуль включён + право группы R или W |
| Запись | RestAccess::requireWrite() |
Модуль включён + право группы W |
| Запись конфигурации | RestAccess::requireWriteAllowDisabled() |
Право группы W (даже при switchOn=N) — только hints.config.update |
| Авторизация | requireAuthorized() |
Любой авторизованный пользователь (до проверки прав модуля) |
Важно: доступ к методу ≠ доступ к данным. Например, hints.show.list без права W возвращает только просмотры текущего пользователя. hints.show.skip доступен при праве чтения, но параметр userId для другого пользователя требует W.
Права групп настраиваются в админке Bitrix (Настройки → Права доступа → модуль «Интерактивные подсказки»).
Формат ответа
Конверт модуля внутри обёртки Bitrix REST:
| Поле | Описание |
|---|---|
result.result |
Данные или null при ошибке |
result.error |
null или { code, message, details } |
next |
Смещение следующей страницы (list) или отсутствует; верхний уровень ответа Bitrix, рядом с result |
total |
Общее число записей (list); верхний уровень ответа Bitrix |
Пагинация
Для list-методов:
| Параметр | По умолчанию | Описание |
|---|---|---|
limit |
50 | Размер страницы, максимум 500 |
offset |
0 | Смещение |
fetchAll |
false | Вернуть все записи; защитный лимит 5000 (FETCH_ALL_LIMIT_EXCEEDED) |
filter |
— | Mongo-style фильтр ($eq, $in, …) |
Альтернативные имена фильтра в query: listFilter, mongoFilter (JSON-строка или объект).
Пакетные вызовы
Отдельного hints.batch нет. Несколько методов за один HTTP-запрос — штатный batch Bitrix24.
Разделы справочника
| Раздел | Описание |
|---|---|
| Служебные | hints.schema |
| Настройки | hints.config.* |
| Страницы | hints.page.* |
| Подсказки | hints.hint.* |
| Просмотры | hints.show.* |
| Коды ошибок | Полный перечень |
Всего методов в текущем коде: 20.