Данные из API передаются в формате JSON.
Параметры для подключения:
- VERSION — 1.0
- KEY — Вы можете его посмотреть, авторизовавшись в личном кабинете на странице https://www.commentbook.ru/admin/key
- URL — https://www.commentbook.ru/api/{VERSION}/?key={KEY}
Внимание! Ключ(параметр key) необходимо передавать в каждом запросе!
Параметры запроса на получение отзывов:
- ACTION — loadYamapsComments
- SOURCE — api
- SORT — Cортировка, может принимать занчения:
-
- date
— по дате
-
- rating
— по рейтингу(звездочки)
-
- rank
— по полезности отзыва
-
- SORT_TYPE — Тип сортировки
-
- asc
— по возрастанию
-
- desc
— по убыванию
-
- LIMIT — Количество отображаемых отзывов, по умолчанию «10»
- PAGE — Номер страницы, по умолчанию «1»
- URL — http://www.commentbook.ru/api/{VERSION}/?key={KEY}&action={ACTION}&source=api&sort={SORT}&sort_type={SORT_TYPE}&limit={LIMIT}&page={PAGE}
Пример запроса:
https://www.commentbook.ru/api/v1/?key={%KEY%}&action=loadYamapsComments&source=api&sort=date&sort_type=desc&limit=10&page=1
Пример запроса с ответом ( обратите внимание, в данном запросе указан тестовый ключ )
https://www.commentbook.ru/api/v1/?key=f9b5d32e1340551ad387534edd599232&&source=api&action=loadYamapsComments
Параметры ответа:
- STATUS — true|false. В случае ошибки будет получен ответ false
- TOTAL_COUNT — Всего отзывов
- COMMENTS — Массив отзывов
- id — идентификатор отзыва
- review_id — уникальный идентификатор отзыва на Я.Картах
- author_name — имя автора
- author_profession_level — уровень автора
- text — текст отзыва
- rating — рейтинг(значение от 1 до 5)
- likes — лайки
- dislikes — дизлайки
- updated_time — время обновления
- business_Id — ваш ID на Я.Картах
- date_display — отображаемая дата
Пример ответа:
{
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": "4140461",
"review_id": "N49yVdqv7n32rtFfgM0CDAtAS1ETnn",
"author_name": "P",
"author_profession_level": "Знаток города 8 уровня",
"text": "Очень большой и удобный магазин,здесь хорошие скидки,большое разнообразие товара,рядом парковка (перекрёсток находится на -1 этаже и на этом же этаже есть парковка),выходя из магазина,сумки можно сразу положить в машину,и ничего не нужно далеко тащить,очень удобно",
"rating": "5",
"likes": "3",
"dislikes": "1",
"updated_time": "1535595593",
"business_Id": "191196579037",
"created_at": "2019-12-09 11:27:23",
"updated_at": "2019-12-09 11:41:40",
"was_updated": "1",
"author": "P",
"date": "30.08.2018",
"date_display": "30 августа 2018"
}
}