Все методы
Весь API целиком, одной страницей. Адрес https://api.rewio.tech, префикс /v3, ключ в заголовке
X-API-Key у каждого запроса. Название метода ведёт на его страницу с параметрами,
полями ответа и живым примером.
Отзывы и аналитика
| Метод | Что делает |
|---|---|
GET /v3/sources | Справочник площадок: id, машинное имя, шкала оценок, что площадка умеет. |
GET /v3/reviews | Отзывы объекта или папки: фильтры по оценке, дате, площадке и тексту, сортировка, страницы. |
GET /v3/reviews/{review_id} | Один отзыв по идентификатору – та же модель, что в ленте. |
GET /v3/reviews/sync | Поток изменений с курсором – чтобы держать у себя актуальную копию отзывов. |
GET /v3/analytics | Сводка по объекту или папке: средняя оценка, распределение, полнота и скорость ответов. |
GET /v3/analytics/timeseries | Те же метрики по дням, неделям или месяцам. |
GET /v3/ratings | Оценка объекта на каждой площадке и число оценок. |
GET /v3/ratings/history | Как менялась оценка объекта на площадках. |
Объекты и ссылки
Объект – то, о чём вы собираете отзывы (отель, клиника, филиал, врач). Ссылка – его страница на конкретной площадке.
| Метод | Что делает |
|---|---|
POST /v3/objects | Создать объект, сразу со ссылками на площадки. |
GET /v3/objects | Список объектов со ссылками и состоянием сбора. |
GET /v3/objects/{object_id} | Один объект со всеми его ссылками. |
PUT /v3/objects/{object_id} | Переименовать объект, включить или выключить его. |
PUT /v3/objects | Включить или выключить несколько объектов одним запросом. |
DELETE /v3/objects/{object_id} | Удалить объект вместе с его ссылками. |
POST /v3/objects/{object_id}/links | Добавить в объект ссылки на площадки. |
GET /v3/objects/{object_id}/links | Ссылки объекта и состояние сбора по каждой. |
PUT /v3/objects/{object_id}/links/{link_id} | Переименовать ссылку или остановить сбор по ней. |
DELETE /v3/objects/{object_id}/links/{link_id} | Удалить ссылку из объекта. |
Папки
Уровень выше: набор объектов, по которому можно спросить отзывы и
аналитику одним параметром folder_id.
| Метод | Что делает |
|---|---|
POST /v3/folders | Создать папку и положить в неё объекты. |
GET /v3/folders | Все папки с подпапками и составом. |
GET /v3/folders/{folder_id} | Одна папка со своими объектами и подпапками. |
PATCH /v3/folders/{folder_id} | Переименовать, перенести или заменить состав. |
DELETE /v3/folders/{folder_id} | Удалить папку, не трогая объекты внутри. |
Дополнительный сбор отзывов
Сбор новых отзывов вне расписания – раз в сутки на объект, тариф «Полный». Правила – на странице «Как работает дополнительный сбор отзывов».
| Метод | Что делает |
|---|---|
POST /v3/objects/{object_id}/refresh | Запустить сбор по объекту: новые отзывы со всех площадок или ещё раз с площадок, где не получилось. |
GET /v3/objects/{object_id}/refresh | Можно ли запустить сбор сейчас, когда снова и итог по каждой площадке. |
GET /v3/objects/refresh | То же состояние по всем объектам аккаунта. |
POST /v3/folders/{folder_id}/refresh | Запустить сбор по всем объектам папки и её подпапок. |
GET /v3/folders/{folder_id}/refresh | Состояние сбора по каждому объекту папки. |
Ответы на отзывы
Ответ публикуется под отзывом на самой площадке. Включается по запросу – напишите на
info@rewio.ru; нужен ключ full и тариф «Полный» (на пробном доступе – три ответа на площадку). Подробности –
в руководстве «Как отвечать на отзывы».
| Метод | Что делает |
|---|---|
PUT /v3/reviews/{review_id}/reply | Опубликовать ответ или заменить уже стоящий. |
GET /v3/reviews/{review_id}/reply | Состояние ответа: отправлен, принят площадкой, опубликован. |
DELETE /v3/reviews/{review_id}/reply | Удалить ваш ответ с площадки. |
Жалобы на отзывы
Жалоба подаётся на самой площадке от имени организации – там, где у вас подключены ответы.
Форма у каждой площадки своя: Яндекс – текст, 2ГИС – категория и текст, Google – категория.
Нужен ключ full и тариф «Полный» (на пробном доступе – три жалобы на площадку).
| Метод | Что делает |
|---|---|
GET /v3/reviews/{review_id}/complaints | Форма площадки, жалобы на отзыв и можно ли подать сейчас. |
POST /v3/reviews/{review_id}/complaints | Пожаловаться на отзыв. |
GET /v3/complaints | Ваши жалобы вместе с отзывами – по статусу. |
Вебхуки
| Метод | Что делает |
|---|---|
POST /v3/webhooks | Получать новые отзывы и ответы пушем на свой адрес. |
GET /v3/webhooks | Все вебхуки аккаунта и состояние доставки. |
PATCH /v3/webhooks/{webhook_id} | Поменять адрес, объекты и фильтры или поставить на паузу. |
DELETE /v3/webhooks/{webhook_id} | Удалить вебхук. |
POST /v3/webhooks/{webhook_id}/test | Пробное событие с настоящей подписью. |
GET /v3/webhooks/secret | Секрет, которым подписаны все доставки аккаунта. |
POST /v3/webhooks/rotate-secret | Выпустить новый секрет подписи. 24 часа доставки подписываются и новым, и старым секретом. |
Для виджетов
Скрыть неудачный отзыв и закрепить удачный. Действует на выдачу, а не на данные: исходные отзывы остаются как есть.
| Метод | Что делает |
|---|---|
POST /v3/objects/{object_id}/hidden-reviews | Убрать отзывы из ленты этого объекта. |
GET /v3/objects/{object_id}/hidden-reviews | Что сейчас скрыто. |
DELETE /v3/objects/{object_id}/hidden-reviews | Вернуть отзывы в ленту. |
POST /v3/objects/{object_id}/pinned-reviews | Закрепить отзывы наверху списка. |
GET /v3/objects/{object_id}/pinned-reviews | Что закреплено и в каком порядке. |
PUT /v3/objects/{object_id}/pinned-reviews | Заменить список закреплённых целиком. |
DELETE /v3/objects/{object_id}/pinned-reviews | Открепить, оставив отзывы в ленте. |
Дополнительно
| Метод | Что делает |
|---|---|
POST /v3/support/message | Написать в поддержку. Работает с любым ключом, включая read_only. |
Без ключа
| Метод | Что делает |
|---|---|
GET /health | API на связи. |
GET /health/read | Чтение работает – методы отзывов и аналитики ответят. Иначе 503. |
Ключи и доступ описаны в отдельном разделе, формат ошибок – в Ошибках, а что такое объект и ссылка – в Модели данных.