Техническое описание API Версия 1.2

Техническое описание API
Версия 1.2
Оглавление
Описание: ......................................................................................................................................................................... 3
Параметры для передачи: .............................................................................................................................................. 3
Пример запроса к API:................................................................................................................................................. 3
Методы, реализованные в API сайта case.ru ................................................................................................................ 3
Описание xml данных: .................................................................................................................................................... 3
Получение списка товарных групп: ........................................................................................................................... 3
Получение товаров: .................................................................................................................................................... 4
Получение списка свойств товара ............................................................................................................................. 6
Получение значений свойств товаров ....................................................................................................................... 6
Получение цен к товарам ........................................................................................................................................... 8
Резервирование товара .............................................................................................................................................. 9
Оформление заказа .................................................................................................................................................. 10
Получение изображений .......................................................................................................................................... 11
Описание:
Запрос к базе данных case.ru осуществляется методом POST. Для авторизации используется логин и пароль, а
также привязка IP адреса клиента. Для получения логина и пароля, а также изменения IP адреса свяжитесь со
своим менеджером.
Путь к обработчику API:
http://test.case.ru/services/caseApi/api.php
Параметры для передачи:
method - название метода
data - xml данные с параметрами запроса
pass - ключ для подключения к API
uid - id пользователя на сайте case.ru, отображается в личном кабинете на вкладке профиль
Пример запроса к API:
http://case.ru/services/caseApi/api.php?uid=4&pass=pass&method=getGroups&data=<?xml
version="1.0"?><requestGetGroups><group>*</group></requestGetGroups>
Методы, реализованные в API сайта case.ru
getGroups – получение списка товарных групп
getItems – получение товаров
getItemProps – получение свойств к товарам
getPrices – получение цен к товарам
getProps – получение списка свойств
updateReserve – резервирование товара
getPicture – получение изображений товара
Описание xml данных:
Получение списка товарных групп:
Метод getGroups позволяет получить дерево товарных групп B2B системы КЕЙС.РУ. В зависимости от
указанных параметров возвращается либо дерево целиком, либо подчиненные ветви.
Запрос:
<?xml version="1.0"?>
<requestGetGroups>
<group>3286</group>
</requestGetGroups>
Параметры:
group
Принимает значения:
* - все группы в виде дерева
3286 - id группы родителя (для получения подгрупп конкретной группы)
Ответ:
<?xml version="1.0"?>
<responseGetGroups>
<groups>
<group>
<id>5217</id>
<name>Портативная акустика</name>
<parent>3286</parent>
</group>
<group>
<id>3299</id>
<name>Смартфоны</name>
<parent>3286</parent>
</group>
</groups>
</responseGetGroups>
Параметры:
id
Идентификатор группы
name
Название группы
parent
Идентификатор родительской группы
Получение товаров:
Метод getItems позволяет получить наименование товара по его id, либо список товаров по id группы.
В случае не указания id товара, указание id группы является обязательным и наоборот, если не указан id
группы, обязательным является указание id товара.
Запрос:
<?xml version="1.0"?>
<requestGetItems>
<group>5310</group>
<item>334009</item>
</requestGetItems>
Параметры:
group
Принимает значения:
* - искать во всех группах
2345 - id группы (для получения товаров из данной группы)
item
Принимает значения:
* - все товары в каталоге
334009 - id конкретного товара
Ответ:
<?xml version="1.0"?>
<responseGetItems>
<itemsCount>1012</itemsCount>
<items>
<item>
<id>263756</id>
<name>Портативный динамик Creative</name>
<section>5217</section>
<CRC32>2761913380</CRC32>
</item>
<item>
<id>332626</id>
<name>Портативный динамик JBL</name>
<section>5217</section>
<CRC32>276191380</CRC32>
</item>
</items>
</responseGetItems>
Параметры:
id
Идентификатор товара
name
Название товара
itemsCount
Количество выбранных товаров
CRC32
Контрольная сумма, для определения изменения свойств (если контрольная
сумма не изменилась, то свойства у товара не поменялись)
section
Идентификатор секции
Получение списка свойств товара
Метод getProps позволяет получить наименование свойств характеристик товара по id свойства
В случае не указания id товара, указание id группы является обязательным и наоборот, если не указан id
группы, обязательным является указание id товара.
Запрос:
<?xml version="1.0"?>
<requestGetProps>
<prop>*</prop>
</requestGetProps>
Параметры:
prop
Принимает значения:
2345 - id свойства (для получения конкретного свойства)
* - полный список всех свойств
Ответ:
<?xml version="1.0"?>
<responseGetProps>
<propsCount>1</propsCount>
<props>
<prop>
<pid>234</pid>
<value>Диагональ экрана</value>
</prop>
</props>
</responseGetProps>
Параметры:
pid
Идентификатор свойства
value
Наименование свойства
propsCount
Количество свойств
Получение значений свойств товаров
С помощью метода getItemProps можно получить значения характеристик товара по id группы товара, либо по
id товара.
Запрос:
<?xml version="1.0"?>
<requestGetItemProps>
<group>4546</group>
<item>123456</item>
</requestGetItemProps>
Параметры:
group
4546 - id группы товара
item
123456 - id товара
Ответ:
<?xml version="1.0"?>
<responseGetItemProps>
<item>
<id>234</id>
<props>
<prop>
<pid>234</pid>
<name>Разрешение экрана</name>
<value>1920 х 1080</value>
</prop>
<prop>
<pid>456</pid>
<name>Диагональ экрана</name>
<value>19 дюймов</value>
</prop>
</props>
</item>
</responseGetItemProps>
Параметры:
id
Идентификатор товара
pid
Идентификатор свойства характеристики товара
name
Наименование свойства характеристики товара
value
Значение свойства характеристики товара
Получение цен к товарам
Метод getPrices получает цену товара по его id, либо цену списка товаров по id группы.
В случае не указания id товара, указание id группы является обязательным и наоборот, если не указан id
группы, обязательным является указание id товара.
Запрос:
<?xml version="1.0"?>
<requestGetPrices>
<item>234546</item>
<group>5310</group>
</requestGetPrices>
Параметры:
item
Принимает значения:
234546 - id товара
Ответ:
<?xml version="1.0"?>
<responseGetPrices>
<itemsCount>1</itemsCount>
<items>
<item>
<id>234</id>
<prices>
<price>
<type>1</type>
<value>34.56</value>
</price>
<price>
<type>2</type>
<value>56.54</value>
</price>
</prices>
<quantity>3</quantity>
<store>ROV</store>
</item>
</items>
</responseGetPrices>
Параметры:
id
Идентификатор товара
type
Тип цены (DILLER – цена партнера, RETAIL – розничная цена на сайте case.ru,
DOLLAR – цена в долларах)
value
Значение цены в рублях, или в долларах для 3 пункта
quantity
Количество товара на складе
store
Склад: ROV, MSC, TR
itemsCount
Количество выбранного товара
Резервирование товара
Данный метод осуществляет резервирование товара в корзине B2B системы КЕЙС.РУ. Работает аналогично
ручному добавлению товара в корзину на сайте.
Запрос:
<?xml version="1.0"?>
<requestUpdateReserve>
<item>
<id>345546</id>
<count>2</count>
</item>
</requestUpdateReserve>
Параметры:
id
Идентификатор товара
count
Количество товара
Ответ:
<?xml version="1.0"?>
<responseUpdateReserve>
<item>
<id>345546</id>
<count>2</count>
<status>ok</status>
</item>
</responseUpdateReserve>
Параметры:
id
Идентификатор товара
count
Количество товара
status
Статус резерва
Принимает значения:
ok – товар добавлен в резерв
error-213 – ошибка добавления товара и код ошибки
Оформление заказа
Метод saleOrder осуществляет оформление заказа в корзине B2B системы КЕЙС.РУ. Работает аналогично
ручному оформлению заказа на сайте.
Запрос:
<?xml version="1.0"?>
<requestSaleOrder>
<item>
<id>238909</id>
<count>2</count>
<comment>номер заказа 300599</comment>
</item>
</requestSaleOrder>
Параметры:
id
Идентификатор товара
count
Количество товара
comment
Комментарий к заказу
Ответ:
В случае удачного оформления заказа
<?xml version="1.0"?>
<responseSaleOrder>
<item>
<id>238909</id>
<result>1</result>
</item>
</ responseSaleOrder >
Параметры:
id
Идентификатор товара
result
ok – товар добавлен
В случае ошибки при оформления заказа
<?xml version="1.0"?>
<responseSaleOrder>
<error>
<id>238909</id>
<count_limit>1</count_limit>
</error>
</ responseSaleOrder >
Параметры:
id
Идентификатор товара
count_limit
Количество товара доступное для заказа
Получение изображений
Метод getPicture позволяет получить ссылку на изображение товара по id группы товара, либо по id товара.
В случае не указания id товара, указание id группы является обязательным и наоборот, если не указан id
группы, обязательным является указание id товара.
Запрос:
<?xml version="1.0"?>
<requestGetPicture>
<group>123</group>
<item>256</item>
</ requestGetPicture>
Параметры:
group
123 - id группы товара
item
256 - id товара
Ответ:
<?xml version="1.0"?>
<responseGetPicture>
<picture>
<id>263756</id>
<value>http://www.case.ru/upload/iblock/a2f/a2f43142df15bf8df5b7fa1cb3201845.jpg</value>
<CRC32PIC>123123 </CRC32PIC>
</picture>
<picture>
<id>332627</id>
<value>http://www.case.ru/upload/iblock/60e/60e072b30530cc74b0928ed30829ab92.jpg</value>
<CRC32PIC>123123 </CRC32PIC>
</picture>
</responseGetPicture>
Параметры:
id
Идентификатор свойства
value
Ссылка на картинку
CRC32PIC
Контрольная сумма, для определения изменения изображения (если
контрольная сумма не изменилась, то изображение у товара не поменялось)