Инструменты пользователя

Инструменты сайта


ru:api_solutions:api_product_reviews

API-интерфейс #6: Отзывы о товаре

API-интерфейс для отправки клиентского XML-запроса и получение XML/JSON ответа от API сервера со списком отрицательных или положительных отзывов о товаре (выборка по ID товара или по ID продавца).


XML-запрос (пример)

URL для передачи запроса
https://axefile.com/api/reviews_list/
Метод POST
Запрос Получение результатов по ID товара:
<?xml version="1.0" encoding="UTF-8"?>
<request api_version="1.0">
    <merchant_data>
        <merchant>120</merchant>
        <signature>J6NDWTCOPZ2GLD3GGODXIYJESHBUGT13</signature>
    </merchant_data>
    <data>
        <type_reviews>1</type_reviews>
        <seller></seller>
        <good_id>1220</good_id>
        <page>0</page>
        <rows>25</rows>
        <order>desc</order>
        <format>xml</format>
    </data>
</request>

Получение результатов по ID продавца:

<?xml version="1.0" encoding="UTF-8"?>
<request api_version="1.0">
    <merchant_data>
        <merchant>120</merchant>
        <signature>J6NDWTCOPZ2GLD3GGODXIYJESHBUGT13</signature>
    </merchant_data>
    <data>
        <type_reviews>1</type_reviews>
        <seller>169</seller>
        <good_id></good_id>
        <page>0</page>
        <rows>25</rows>
        <order>desc</order>
        <format>xml</format>
    </data>
</request>

Параметры запроса

Название Статус Описание Тип данных
merchantrequiredУникальный идентификатор продавца(агента), полученный при регистрации (можно посмотреть в личном кабинете) (integer)
signaturerequiredСигнатура запроса рассчитывается следующим образом (PHP):
$sign=sha1(md5($merchant.$shop_hash))

где
$merchant - уникальный идентификатор продавца (агента)
$shop_hash - секретный ключ, который можно получить здесь: https://axefile.com/ru/partner/referal

(string)
type_reviewsrequiredТип отзыва: 0/1 (1-позитивный или 0-негативный). Обязательный параметр. (integer)
selleroptional/requiredID продавца товаров. Данный параметр seller можно использовать одновременно с параметром good_id. Параметр обязательный, при условии, если отсутствует параметр good_id (integer)
good_idoptional/requiredID товара. Данный параметр good_id можно использовать одновременно с параметром seller. Параметр обязательный, при условии, если отсутствует параметр seller (integer)
pageoptionalЗначение указывает с какой страницы выводить результаты. По умолчанию: 0 (integer)
rowsoptionalКоличество строк на странице. По умолчанию: 25 (integer)
orderoptionalСортировка по дате добавления. По умолчанию: от новых к старым - desc (string)
formatoptionalФормат ответа на запрос (xml/json). По умолчанию: xml (string)

XML-ответ на запрос (пример)

<?xml version="1.0" encoding="UTF-8"?>
<response api_version="1.0">
  <reviews cnt="2">
    <review id="0">
      <id>3</id>
      <seller>145</seller>
      <good_id>1220</good_id>
      <body_review>Отлично</body_review>
      <rate>1</rate>
      <date>1435491730</date>
    </review>
    <review id="1">
      <id>2</id>
      <user_id>145</user_id>
      <good_id>1220</good_id>
      <body_review>Все отлично работает! Респект продавцу!</body_review>
      <rate>1</rate>
      <date>1435491352</date>
    </review>
  </reviews>
  <cnt_reviews>0</cnt_reviews>
  <status status_descr="Successful sending a response from the API-server">success</status>
</response>

JSON-ответ на запрос (пример)

//Ответ приходит в JSON формате, но для визуализации мы его выводим в виде массива данных (PHP):
print_r(json_decode($json_data, TRUE);)
Array
(
    [reviews] => Array
        (
            [0] => Array
                (
                    [id] => 2
                    [seller] => 145
                    [good_id] => 1220
                    [body_review] => Все отлично работает! Респект продавцу!
                    [rate] => 1
                    [date] => 1435494575
                )
 
            [1] => Array
                (
                    [id] => 3
                    [seller] => 145
                    [good_id] => 1220
                    [body_review] => Отлично
                    [rate] => 1
                    [date] => 1435491730
                )
 
        )
 
    [cnt_reviews] => 0
    [status] => success
    [status_descr] => Successful sending a response from the API-server
)

Параметры ответа (XML/JSON)

Название Описание Тип данных
reviews/ Отзывы товара. Атрибут cnt - общее кол-во отзывов
reviews/review/ Отзывы по товару, выводимые в цикле. Атрибут id - порядковый номер
reviews/review/idID отзыва(integer)
reviews/review/sellerID продавца (integer)
reviews/review/good_idID товара (integer)
reviews/review/dateДата добавления отзыва в формате *unix time stamp (integer)
reviews/review/body_reviewТекст отзыва (text)
reviews/review/rateТип отзыва (1-положительный или 0-отрицательный) (integer)
cnt_reviewsКоличество отзывов (integer)
status (XML)Статус ответа от API сервера: success - успешное выполнение, error - ошибка выполнения. Для более полной расшифровки в теге передается XML-атрибут @status_descr - описание статуса (string)
status (JSON)Статус ответа от API сервера: success - успешное выполнение, error - ошибка выполнения. (string)
status_descr (JSON)Описание статуса ответа от API сервера. (string)

Для получения и использования API-решений Вам необходимо авторизоваться, используя форму входа для партнеров/продавцов, чтобы получить серетный ключ. Если вы еще не зарегистрированы как партнер, то можете сделать это прямо сейчас: перейти к регистрации.

ru/api_solutions/api_product_reviews.txt · Последние изменения: 2015/09/26 11:02 (внешнее изменение)