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

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


ru:api_solutions:api_list_category

API-интерфейс #4: Список категорий

API-интерфейс для отправки клиентского XML-запроса и получение XML/JSON ответа от API сервера со всеми категориями для товаров.


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

URL для передачи запроса
https://axefile.com/api/category_list/
Метод POST
Запрос
<?xml version="1.0" encoding="UTF-8"?>
<request api_version="1.0">
    <merchant_data>
        <merchant>120</merchant>
        <signature>J6NDWTCOPZ2GLD3GGODXIYJESHBUGT13</signature>
    </merchant_data>
    <data>
        <language>ru</language>
        <format>xml</format>
    </data>
</request>

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

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

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

(string)
languageoptionalНа каком языке выводить названия категорий. Доступные языки: (ru - русский, en - английский). По умолчанию: en (string). (string)
formatoptionalФормат ответа на запрос (xml/json). По умолчанию: xml (string)

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

<?xml version="1.0" encoding="UTF-8"?>
<response api_version="1.0">
  <category id="0">
    <name_category>Дизайн</name_category>
  </category>
  <category id="1">
    <name_category>Электронные книги</name_category>
  </category>
  <category id="2">
    <name_category>Видео и фильмы</name_category>
  </category>
  <category id="3">
    <name_category>Аудио файлы</name_category>
  </category>
  <category id="4">
    <name_category>Программы</name_category>
  </category>
  <category id="5">
    <name_category>Игры</name_category>
  </category>
  <category id="6">
    <name_category>Коды и аккаунты</name_category>
  </category>
  <status status_descr="Successful sending a response from the API-server">success</status>
</response>

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

Название Описание Тип данных
categoryКатегория для товаров содержит атрибут id - уникальный идентификатор категории (integer). Категории могут содержать в себе одну или множество вложенных подкатегорий, но не более 4 уровней вложений.
Идентификаторы основных категорий:
Дизайн — 0
Электронные книги — 1
Видео и фильмы — 2
Аудио файлы — 3
Программы — 4
Игры — 5
Коды и аккаунты — 6
category/name_categoryНазвание категории (string)
statusСтатус ответа от API сервера: success - успешное выполнение, error - ошибка выполнения. Для более полной расшифровки в теге передается XML-атрибут @status_descr - описание статуса (string)

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

//Ответ приходит в JSON формате, но для визуализации мы его выводим в виде массива данных (PHP):
print_r(json_decode($json_data, TRUE);)
Array
(
    [category] => Array
        (
            [0] => Array
                (
                    [category_id] => 0
                    [parent_id] =>
                    [category_title] => Дизайн
                )
 
            [1] => Array
                (
                    [category_id] => 1
                    [parent_id] =>
                    [category_title] => Электронные книги
                )
 
            [2] => Array
                (
                    [category_id] => 2
                    [parent_id] =>
                    [category_title] => Видео и фильмы
                )
 
            [3] => Array
                (
                    [category_id] => 3
                    [parent_id] =>
                    [category_title] => Аудио файлы
                )
 
            [4] => Array
                (
                    [category_id] => 4
                    [parent_id] =>
                    [category_title] => Программы
                )
 
            [5] => Array
                (
                    [category_id] => 5
                    [parent_id] =>
                    [category_title] => Игры
                )
 
            [6] => Array
                (
                    [category_id] => 6
                    [parent_id] =>
                    [category_title] => Коды и аккаунты
                )
 
        )
 
    [status] => success
    [status_descr] => Successful sending a response from the API-server
)

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

Название Описание Тип данных
categoryКатегория для товаров содержит атрибут id - уникальный идентификатор категории (integer). Категории могут содержать в себе одну или множество вложенных подкатегорий, но не более 4 уровней вложений.
Идентификаторы основных категорий:
Дизайн — 0
Электронные книги — 1
Видео и фильмы — 2
Аудио файлы — 3
Программы — 4
Игры — 5
Коды и аккаунты — 6
category/category_idУникальный идентификатор категории (ID категории) (integer)
category/parent_idУникальный идентификатор категории родителя (ID родительской категории) (integer)
category/category_titleНазвание категории. Может выводиться в одном из языков (ru - русский, en - английский), который был указан в запросе language. (string)
category/childrenПрисутствует в том случае, если в текущей категории имеется вложенные подкатегории. Может содержать список иерархически-вложенных подкатегорий товаров (одну или множество вложенных подкатегорий), но не более 3 уровней вложений.
statusСтатус ответа от API сервера: success - успешное выполнение, error - ошибка выполнения. (string)
status_descrОписание статуса ответа от API сервера. (string)

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

ru/api_solutions/api_list_category.txt · Последние изменения: 2016/03/18 10:20 — root