REST API модуля «Библиотека»
Справочник REST-методов ithive.library для интеграций, входящих вебхуков и AI-агентов.
Базовый URL
https://{портал}/rest/{user_id}/{webhook_code}/{method}.json
Пример (тестовый стенд):
https://76590.dev.wehive.digital/rest/1/{webhook_code}/library.book.list.json
Scope и аутентификация
- Scope:
library - Аутентификация: входящий вебхук Bitrix24 или OAuth/сессия
- Все методы требуют авторизованного пользователя. Дополнительно — доступ к разделу «Библиотека» (
ACCESS_DENIED).
Формат ответа
| Поле | Описание |
|---|---|
result.result |
Данные или null при ошибке |
result.error |
null или { code, message, details } |
total |
Для list (на уровне Bitrix result) |
next |
Смещение следующей страницы или null |
Пагинация
| Параметр | По умолчанию | Описание |
|---|---|---|
limit |
50 | Макс. 500 |
offset |
0 | Смещение |
fetchAll |
false | Лимит 5000 |
filter |
— | Mongo-style |
Именование review.add вместо review.save
Метод сохранения отзыва — library.review.add, не save (WAF на .save).
Разделы
| Раздел | Методы |
|---|---|
| Служебные | schema |
| Книги | book.* |
| Категории | category.* |
| Отзывы | review.* |
| История выдачи | history.* |
| Рейтинг | rating.* |
| Подписка | subscription.* |
| Справочники | enum.* |
| Интеграции | integration.* |
| ИПР | ipr.* |
| Коды ошибок | — |
Всего методов: 33.
Предыдущая
Следующая