Данные из API передаются в формате JSON.
Параметры для подключения:
- VERSION — 1.0
- KEY — Вы можете его посмотреть, авторизовавшись в личном кабинете на странице https://www.commentbook.ru/admin/key
- URL — https://www.commentbook.ru/api/{VERSION}/?key={KEY}
Внимание! Ключ(параметр key) необходимо передавать в каждом запросе!
Параметры запроса на получение отзывов:
- ACTION — loadShopComments
- SORT — Cортировка, может принимать занчения:
-
- date
— по дате
-
- rating
— по рейтингу(звездочки)
-
- rank
— по полезности отзыва
-
- SORT_TYPE — Тип сортировки
-
- asc
— по возрастанию
-
- desc
— по убыванию
-
- LIMIT — Количество отображаемых отзывов, по умолчанию «10»
- PAGE — Номер страницы, по умолчанию «1»
- URL — http://www.commentbook.ru/api/{VERSION}/?key={KEY}&action={ACTION}&sort={SORT}&sort_type={SORT_TYPE}&limit={LIMIT}&page={PAGE}
Пример запроса:
https://www.commentbook.ru/api/v1/?key={%KEY%}&action=loadShopComments&sort=date&sort_type=desc&limit=10&page=1
Параметры ответа:
- STATUS — true|false. В случае ошибки будет полчен ответ false
- TOTAL_COUNT — Всего отзывов по этому товару
- COMMENTS — Массив отзывов
- id — идентификатор отзыва
- text — текст отзыва
- plus — плюсы товара
- minus — минусы товара
- rating — рейтинг(значение от 1 до 5)
- date — да ( 1.01.2014 )
- display_date — дата ( 1 января 2014 )
- link — ссылка на раздел отзывов о товаре на Яндекс.Маркете
Пример ответа:
{ status: true, total_count: 3, count: 1, average_rating: 5, "stars": { "1": { "count": "0" }, "2": { "count": "0" }, "3": { "count": "0" }, "4": { "count": "0" }, "5": { "count": "2" } }, "comments": [ { "id": "471704", "text": "Все отлично", "plus": "", "minus": "", "date": "20.07.2015", "rating": 5, "agree": 0, "reject": 0, "author": "Руслан", "delivery": "доставка", "moderate": "1", "commentbook_id": "14", "email": "email@test.com", "negative": "0", "sended_at": null, "inserted_at": null, "yandex_old_comment_id": null, "cb_agree": null, "cb_reject": null, "timestamp": "1437386016000", "date_display": "20 июля 2015", "provider": "book", "answers": [ { "timestamp": "1464249981", "data": "26.05.2016", "date_display": "26 мая 2016", "author": "Артем", "text": "Текст отзыва" } ] } }