# Документация

- [Обзор](/overview): Rewio собирает отзывы с 30+ площадок и отдаёт их одним REST API в едином формате.
- [Быстрый старт](/quickstart): От первого запроса до отзывов по своему объекту за четыре шага.
- [Интеграция через AI](/ai): Skill для агента и машиночитаемые версии документации — чтобы интеграция с Rewio была написана правильно с первого раза.
- [OpenAPI, Postman, Swagger](/tools): Интерактивный просмотр методов, машиночитаемая спецификация и что из неё можно собрать.

- **Основы**
- [Ключи и доступ](/access): Заголовок X-API-Key, два уровня доступа и проверка связи.
- [Модель данных](/data-model): Объект, ссылка, отзыв – и правила, по которым они складываются.
- [Все методы](/methods): Вся поверхность API одной страницей – 41 метод, сгруппированный по смыслу.
- [Где взять ссылку](/link-formats): Что скопировать на каждой площадке – снимки, форматы адресов и разбор отказов.
- [Ошибки](/errors): Единый формат ошибок, коды состояния и машиночитаемые коды.
- Руководства
  - [Как читать отзывы](/guides/reviews): Фильтры, сортировка и постраничная выдача.
  - [Синхронизация данных](/guides/sync): Как держать у себя актуальную копию отзывов — курсор, цикл опроса и четыре правила.
  - [Как отвечать на отзывы](/guides/replies): Публикация ответа под отзывом на самой площадке – одним запросом к API.
  - [Как считать аналитику](/guides/analytics): Сводка и временные ряды без выкачивания отзывов.
  - [Как работать с папками](/guides/folders): Отзывы и аналитика сразу по нескольким объектам одним параметром folder_id.
  - [Как собрать виджет отзывов](/guides/widgets): Закрепить удачный отзыв, убрать неудачный, показать плюсы и минусы отдельно – не трогая собранные данные.
  - [Как принимать вебхуки](/guides/webhooks): Пуш новых отзывов и ответов на ваш сервер с проверкой HMAC-подписи.

- **Справочник API**
- Площадки
  - [Список площадок](/sources/list): Все площадки, с которых Rewio собирает отзывы.
- Объекты
  - [Список объектов](/objects/list): Все ваши объекта со ссылками на площадки, страницами.
  - [Создать объект](/objects/create): Новый объект, отзывы которого вы собираете, сразу со ссылками на площадки.
  - [Получить объект](/objects/get): Один объект со всеми его ссылками.
  - [Обновить объект](/objects/update): Переименовать объект или включить и выключить его.
  - [Включить или выключить объекты](/objects/toggle): Массовый выключатель сразу для набора объектов.
  - [Удалить объект](/objects/delete): Убрать объект вместе с его ссылками.
- Папки
  - [Список папок](/folders/list): Все ваши папки с подпапками и объектами в них.
  - [Получить папку](/folders/get): Одна папка со своими объектами и подпапками.
  - [Создать папку](/folders/create): Папка объединяет объекты, чтобы спрашивать отзывы и аналитику сразу по всем.
  - [Изменить папку](/folders/update): Переименовать, перенести или заменить состав папки.
  - [Удалить папку](/folders/delete): Убрать папку, не трогая объекты внутри.
- Ссылки
  - [Ссылки объекта](/links/list): Все площадки, подключённые к объекту, и состояние сбора по каждой.
  - [Добавить ссылки](/links/add): Подключить к объекту новые площадки.
  - [Обновить ссылку](/links/update): Переименовать ссылку или остановить сбор по ней.
  - [Удалить ссылку](/links/remove): Отключить площадку от объекта.
- Отзывы
  - [Получить отзывы](/reviews/list): Отзывы объекта или папки с фильтрами, сортировкой и постраничной выдачей.
  - [Получить отзыв по id](/reviews/get): Один отзыв по идентификатору – та же модель, что в ленте.
  - [Синхронизация отзывов](/reviews/sync): Поток изменений с курсором — чтобы держать у себя актуальную копию отзывов.
  - [Оценка на площадках](/reviews/ratings): Оценка объекта на площадке и число оценок, из которых она сложилась.
- Ответы
  - [Опубликовать ответ](/replies/publish): Опубликовать ответ на отзыв или заменить уже стоящий.
  - [Удалить ответ](/replies/delete): Удалить ваш ответ с площадки.
- Аналитика
  - [Сводная аналитика](/analytics/summary): Средняя оценка, распределение и ответы организации за период.
  - [Динамика по периодам](/analytics/timeseries): Те же метрики, разложенные по дням, неделям или месяцам.
  - [Динамика оценки](/analytics/ratings-history): Как менялась оценка объекта на площадках – ряд изменений по каждой ссылке.
- Вебхуки
  - [Список вебхуков](/webhooks/list): Все вебхуки аккаунта и состояние доставки по каждому.
  - [Создать вебхук](/webhooks/create): Получать новые отзывы на свой адрес, не опрашивая API.
  - [Изменить вебхук](/webhooks/update): Поменять адрес, объекта и фильтры или поставить доставку на паузу.
  - [Удалить вебхук](/webhooks/delete): Отключить доставку событий на свой адрес.
  - [Тестовая доставка](/webhooks/test): Отправить на свой адрес пробное событие с настоящей подписью.
  - [Секрет подписи](/webhooks/secret): Ключ, которым подписаны все доставки вашего аккаунта.
  - [Перевыпустить секрет](/webhooks/rotate-secret): Заменить ключ подписи, не теряя доставок.
- Для виджетов

  - **Закрепление**
  - [Закреплённые отзывы](/widgets/pinned-list): Отзывы, поднятые в начало выдачи, в их порядке.
  - [Закрепить отзывы](/widgets/pinned-add): Добавить отзывы в конец списка закреплённых.
  - [Задать порядок закреплённых](/widgets/pinned-set): Заменить список закреплённых отзывов целиком.
  - [Открепить отзывы](/widgets/pinned-remove): Убрать отзывы из закреплённых, оставив их в ленте.

  - **Скрытие**
  - [Скрытые отзывы](/widgets/hidden-list): Отзывы, спрятанные в этом объекте.
  - [Скрыть отзывы](/widgets/hidden-add): Убрать отзывы из ленты этого объекта.
  - [Вернуть отзывы в ленту](/widgets/hidden-remove): Снять скрытие с отзывов объекта.

  - **Разбор текста**
  - [Достоинства и недостатки](/widgets/pros-cons): Разобрать отзыв на «что понравилось» и «что не понравилось» там, где площадка спрашивает это отдельно.
- Дополнительно
  - [Написать разработчику](/extra/support): Вопрос по API, ошибка или просьба – прямо из кода, без формы на сайте.
  - [Доступность API](/extra/health): Отвечает ли API вообще. Ключ не нужен.
  - [Проверка чтения данных](/extra/health-read): Ответят ли методы отзывов и аналитики. Ключ не нужен.
  - [Расширенная проверка](/extra/health-detailed): Одна цифра о состоянии сервиса целиком, а не только о том, отвечает ли он.