*
- Обязательно
Параметр запроса с числом на конце
- Значение по умолчанию. Параметр не обязателен для передачи
- Авторизация обязательна
Информация
Статусы
- Неоднократно изменяется в процессе общения в теме
readOnly
- Клиент не авторизован, он не может создать отзыв
firstReview
- У клиента еще нет отзывов, предложить создать первый
addReview
- Уже есть отзывы, предложить добавить еще
maxReviews
- Клиент оставил максимум возможных отзывов, нужны новые доставленные заказы
haveNoOrders
- Нет заказов
Причины
- Причины по которым заказ нельзя выбрать для отзыва
reviewed
- На заказ уже был оставлен отзыв
Состояние страницы и заказы клиента
GET
php8.collectorsshop.ru/api/rest/reviews/info
rating
- Общая информация о рейтинге
total
- int — всего отзывов
average
- int — средняя оценка
ruTotal
- int — отзывов на русском
enTotal
- int — отзывов на английском
status
- str — какой статус имеет клиент
Авторизован
- если запрос от авторизованного юзера
orders_count
- int — число доставленных заказов
reviews_count
- int — число написанных отзывов
Все кроме отзывов юзера
GET
php8.collectorsshop.ru/api/rest/reviews/all
page
- int — номер страницы 1
rating
- int — получить отзывы только с указанной оценкой 0 - все
count
- int — число возвращаемых отзывов 10
menu
- str — фильтр меню по которому нужно показать отзывы
category
- str — фильтр категории по которому нужно показать отзывы
item
- str — фильтр предмет по которому нужно показать отзывы
res
- bln — результат выполнения
pagination
- arr — стандартные данные
reviews
- список отзывов на странице
id
- int — id отзыва
images
- arr — список изображений. /img/reviews/mini/...
rating
- int — оценка
order_id
- int — id заказа
answer
- arr — ответ администратора
text
- str — текст ответа
images
- arr — список изображений. /img/reviews/answers/mini/...
name
- str — имя юзера
steam_id
- str — id юзера в стиме. https://steamcommunity.com/profiles/...
avatar
- str — конечный путь до аватара. /img/users/avatars/...
orders
- int — число заказов
text
- str — текст отзыва
date
- str — время отзыва
item
- arr — информация о товаре
id
- int — id товара
menu
- arr — информация о меню
name
- str — название меню
url
- str — ссылка. /catalog/...
catalog
- arr — информация о каталоге
name
- str — название каталога
url
- str — ссылка. /catalog/{menu.url}/...
name
- str — название предмета
image
- str — конечный путь до изображения. /img/catalog/items/main_images/...
was_edited
- str — время последнего редактирования отзыва
Админ
- у запрашивающего юзера есть роль админа
user_id
- int — id юзера на сайте
code
- int — номер ошибки
error
- str — текст ошибки
Отзывы юзера
GET
php8.collectorsshop.ru/api/rest/reviews/my
1
- Показываются последние 6 отзывов
res
- bln — результат выполнения
reviews
- список отзывов клиента
id
- int — id отзыва
images
- arr — список изображений. /img/reviews/mini/...
rating
- int — оценка
order_id
- int — id заказа
answer
- str — ответ администратора
last_change
- str — время когда в последний раз редактировался отзыв
text
- str — текст отзыва
date
- str — время отзыва
item
- arr — информация о товаре
id
- int — id товара
menu
- arr — информация о меню
name
- str — название меню
url
- str — ссылка. /catalog/...
catalog
- arr — информация о каталоге
name
- str — название каталога
url
- str — ссылка. /catalog/{menu.url}/...
name
- str — название предмета
image
- str — конечный путь до картинки предмета. /img/catalog/items/main_images/...
code
- int — номер ошибки
error
- str — текст ошибки
Получить список заказов для отзыва
GET
php8.collectorsshop.ru/api/rest/reviews/orders
page
- int — номер страницы 1
count
- int — число возвращаемых заказов 3
res
- bln — результат выполнения
orders
- список заказов клиента
id
- int — id отзыва
name
- str — название предмета
image
- str — конечный путь до картинки предмета. /img/catalog/items/main_images/...
available
- bln — доступно для обзора
available - false
- на заказ нельзя отставить отзыв
reason
- str — код причины
code
- int — номер ошибки
error
- str — текст ошибки
Добавить отзыв
POST
php8.collectorsshop.ru/api/rest/reviews/new
1
- Текст, оценка и изображения допускается пустыми, но обязательно должно быть что-то одно из них
2
- Максимальная длина текста - 2000 символов
text
- str — текст отзыва
rating
- int — оценка от 1 до 5
order
- int — id заказа
files
- fls — изображения загружаются до отправки запроса.
res
- bln — результат выполнения
id
- int — id нового отзыва
code
- int — номер ошибки
error
- str — текст ошибки
Изменить отзыв
POST
php8.collectorsshop.ru/api/rest/reviews/change
1
- Отзывы можно изменять только в первые 7 дней после создания
id
- int — id отзыва
text
- str — текст отзыва
rating
- int — оценка от 1 до 5
order
- int — id заказа
images
- arr — массив с именами картинок, в нужном порядке. Отсутствующие названия считаются удаленными
files
- fls — изображения загружаются до отправки запроса.
res
- bln — результат выполнения
code
- int — номер ошибки
error
- str — текст ошибки
История изменения отзыва
GET
php8.collectorsshop.ru/api/rest/reviews/view_changes
id *
- int — id отзыва
res
- bln — результат выполнения
changes
- arr — история изменений
rating
- arr — изменения оценок
was
- int — оценка до изменения
new
- int — оценка после изменения
text
- arr — изменения текста отзыва
was
- str — текст отзыва до изменения
new
- str — текст отзыва после изменения
images
- arr — прошлые изображения
was
- arr — изображения до изменения
new
- arr — изображения после изменения
item
- arr — информация о товаре. Структура аналогична /all.reviews.item
was
- arr — товар до изменения
new
- arr — товар после изменения
date
- str — время изменения
code
- int — номер ошибки
error
- str — текст ошибки
Удалить отзыв
DELETE
php8.collectorsshop.ru/api/rest/reviews/delete
1
- Отзывы можно удлять только в первые 7 дней после создания
id *
- int — id отзыва
res
- bln — результат выполнения
code
- int — номер ошибки
error
- str — текст ошибки
Ответ администратора
POST
php8.collectorsshop.ru/api/rest/reviews/answer
id *
- int — id отзыва
text
- str — текст ответа
images
- arr — массив с именами картинок, в нужном порядке. Отсутствующие названия считаются удаленными
files
- fls — изображения загружаются до отправки запроса.
res
- bln — результат выполнения
code
- int — номер ошибки
error
- str — текст ошибки