| HTTP метод | Endpoint | Ограничение | Комментарий |
|---|---|---|---|
| POST | http://cackle.me/api/3.0/review/post.json | 1 раз в 5 секунд | Импорт отзывов на определенной странице сайта. Кодировка данных запроса UTF-8. |
Параметры запроса:
| Параметр | Описание | Комментарий |
|---|---|---|
| id | Идентификатор вашего виджета | Можно получить в панели администрирования: вкладка Отзывы, меню "Установить", вкладка "CMS Платформа", выбрать Bitrix. |
| siteApiKey | Секретный ключ виджета | Можно получить в панели администрирования: вкладка Отзывы, меню "Установить", вкладка "CMS Платформа", выбрать Bitrix. |
| accountApiKey | Секретный ключ аккаунта | Можно получить в панели администрирования: вкладка Отзывы, меню "Установить", вкладка "CMS Платформа", выбрать Bitrix. |
| reviews | Список отзывов в формате JSON |
Пример параметра reviews:
{
"chan": "12345",
"url": "http://site.ru/product12345",
"title": "Мой сайт | Товар 12345",
"reviews": [{
"id": "111",
"star": "5",
"pros": "Хорошо",
"cons": "Плохо",
"comment": "Комментарий",
"recom": "true",
"up": "8",
"down": "0",
"ip": "84.195.0.32",
"status": "approved",
"created": "1422820372367",
"user": {
"id": "808",
"name": "Остап Бендер",
"email": "ostap@example.org",
"avatar": "//yourscr.com/40cc32af4753cdee62f527ef8ebe37df.png"
}
}, {
"id": "888",
"star": "3",
"comment": "Нормально",
"media": "http://cackle.me/static/img/flat-comment.png http://cackle.me/static/img/flat-review.png",
"ip": "40.105.4.195",
"status": "approved",
"created": "1425412776446",
"name": "Саня",
"email": "san@example.org"
}]
}
Описание полей страницы:
| Параметр | Обязательный | Описание | Комментарий |
|---|---|---|---|
| chan | Нет | Идентификатор к которому будут привязаны отзывы на странице вашего сайта | По умолчанию это адрес страницы без протокола и домена. Например: для адреса http://example.ru/product/12345, chan будет /product/12345. Если ваш сайт использует CMS (Bitrix, OpenCart), то chan это идентификатор поста из БД. |
| url | Да | Адрес страницы | |
| title | Нет | Название страницы | Обычно берется из тега <title>...</title> на странице сайта. |
Описание полей reviews:
| Параметр | Обязательный | Описание | Комментарий |
|---|---|---|---|
| id | Да | Идентификатор отзыва | Уникален в рамках одного виджета. |
| star | Да | Рейтинг отзыва | От 1 до 5 |
| pros | Нет | Достоинства | |
| cons | Нет | Недостатки | |
| comment | Нет | Комментарий | |
| media | Нет | Ссылки на изображения | Список ссылок разделенные пробелами на изображения в форматах png, jpg, gif. |
| recom | Нет | Рекомендация | true - Я рекомендую этот продукт false - Я не рекомендую этот продукт. |
| up | Нет | Положительный рейтинг | Число голосов положительно оценивших данный отзыв. |
| down | Нет | Отрицательный рейтинг | Число голосов отрицательно оценивших данный отзыв. |
| ip | Да | IP адрес | С которого был опубликован отзыв. |
| status | Да | Статус отзыва | Доступны: pending (в ожидании), approved (одобрен), spam (отмечен как СПАМ), deleted (удален). По умолчанию выставляется approved. |
| created | Да | Дата создания | В миллисекундах. |
| user | Да, если name, email отсутствуют | Автор отзыва | Зарегистрированный пользователь вашего сайта. Если подключена услуга "Единая авторизация", то такой пользователь может входить под своим аккаунтом. |
| name | Нет | Имя анонимного юзера | |
| Нет | Email анонимного юзера |