Программный интерфейс My-shop. ru для партнерских магазинов (стр. 3 )

Все запросы партнерского магазина к Интернет-магазину My-shop. ru протоколируются, однако не отображаются в журналах обычных переходов в персональном разделе партнера.

Все ответы My-shop. ru партнерскому магазину имеют формат XML. Корневой элемент всех XML-ответов – «answer», имена всех вложенных элементов соответствуют именам описанных ниже параметров.

Если ответ представляет собой справочник (описание набора однотипных элементов), например, справочник регионов доставки, параметры, описывающие каждый элемент, группируются внутри элемента «item» (это относится ко всем запросам, у которых параметр «request» начинается с префикса «list_» – см. ниже).

Обратите внимание, несмотря на то, что ответ имеет формат XML, в запросе должны быть пары «имя параметра – значение параметра», переданные методом POST, а не XML-документ с этими параметрами.

Кодировка – «windows-1251».

Разделитель целой и дробной части – точка.

Пример ответа на запрос «Информация о цене и доступности товара» (многоточие – пропущенные параметры):

<?xml version="1.0" encoding="windows-1251"?>

<answer>

<version>1.0</version>

<datetime>2010-01-19 14:00:15</datetime>

<error>0</error>

<cost>54.00</cost>

<availability_code>2</availability_code>

…

<time_text_b>2 рабочих дня</time_text_b>

</answer>

Пример ответа на запрос «Справочник способов оплаты» (многоточие – пропущенные способы оплаты):

<?xml version="1.0" encoding="windows-1251"?>

<answer>

<version>1.0</version>

<datetime>2010-01-19 14:00:15</datetime>

<error>0</error>

<item>

<id>0</id>

<name>наличный расчет</name>

</item>

<item>

<id>1</id>

<name>предоплата банковским переводом (Сбербанк и др.)</name>

</item>

…

</answer>

Параметры всех запросов:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
version	ДА	число	Версия API, для работы с которой предназначено программное обеспечение партнерского магазина. Текущая версия API указана в разделе «Версия» (см. выше). О существенных обновлениях API сообщается в рассылке «Новости партнерской программы My-shop. ru». Проверить, подписаны ли Вы на эту рассылку, можно на этой странице: http://my-shop. ru/my/subscriptions См. также раздел «Проверка текущей версии API». Поддержка старых версий API не гарантируется.
partner	ДА	число	Идентификатор партнера.
auth_method	ДА	«plain» или «md5»	Метод аутентификации партнера: «plain» – в параметре «auth_code» передается секретный код, указанный в персональном разделе партнера; «md5» – в параметре «auth_code» передается MD5-хэш строки «auth_salt;request;partner;secret_code», где «auth_salt», «request», «partner» – значения одноименных параметров, передаваемых в том же запросе, а «secret_code» – секретный код, указанный в персональном разделе партнера. Внимание! Значение «partner» здесь должно указываться без ведущих нулей.
auth_salt	Только при аутентификации «md5»	строка	Случайная последовательность до 8 символов (должна генерироваться при каждом запросе). См. параметр «auth_method».
auth_code	ДА	строка	Код для аутентификации партнера. См. параметр «auth_method».
request	ДА	строка	См. ниже.

Параметры всех ответов:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
version	ДА	число	Версия API.
datetime	ДА	дата и время в формате YYYY-MM-DD HH:MM:SS	Дата и время ответа на запрос. Время московское.
error	ДА	число	Результат проверки и выполнения запроса: 0 – нет ошибок в запросе, успешное выполнение запроса, другое число – код ошибки (см. раздел «Справочник кодов ошибок»).
error_text	нет	строка	Текстовое описание ошибки.
expires_sec	нет	число	Количество секунд, на которое можно кэшировать данный ответ.

До оформления заказа

Корзина

Может использоваться для проверки состава заказа и отображения «Корзины» с товарами. Товары, которых нет в наличии, в ответ не включаются (они не должны отображаться в «корзине»).

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_cart»
cart	ДА	строка в формате «X1-Y1,X2-Y2,…Xn-Yn»	Состав заказа: X1, X2…Xn – идентификаторы товаров, Y1, Y2…Yn – соответствующие количества. Внимание! Если в состав заказа включен хотя бы один товар из комплекта товаров, которые не продаются по частям, все остальные части этого комплекта будут добавлены автоматически.

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
id	ДА	число	Код (идентификатор) товара в My-shop. ru.
name	ДА	строка	Наименование товара. Помимо собственно названия может включать информацию о типе товара, формате данных, авторе произведения и т. п.
cost	ДА	число	Стоимость одного экземпляра товара в рублях. Стоимость указывается с учетом «распродажной» скидки, если товар в распродаже и скидка распространяется на заказываемое количество экземпляров. Во всех остальных случаях используется стоимость без учета «распродажной» скидки.
quantity	ДА	число	Количество экземпляров товара в корзине. Может быть меньше количества, указанного в параметре «cart», если указанного там количества точно нет в наличии.

Выбор способов доставки/оплаты

Данный запрос предназначен для формирования интерфейса выбора основных параметров доставки/оплаты заказа, аналогичного соответствующему интерфейсу в My-shop. ru (регион –> доставка –> оплата). В запросе передается состав заказа и код региона доставки, а в ответ на запрос возвращается список всех доступных в данном случае способов доставки и оплаты, а также стоимость доставки данного заказа для каждого сочетания «доставка-оплата».

URL: https://my-shop. ru/cgi-bin/p/info. pl

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

Имя параметра	Обязательный	Формат, допустимые значения	Описание
request	ДА	«list_rdp»	«rdp» – сокращение от «region, delivery, payment».
cart	ДА	строка в формате «X1-Y1,X2-Y2,…Xn-Yn»	Состав заказа: X1, X2…Xn – идентификаторы товаров, Y1, Y2…Yn – соответствующие количества. Внимание! Если в состав заказа включен хотя бы один товар из комплекта товаров, которые не продаются по частям, все остальные части этого комплекта будут добавлены автоматически. Все остальные ошибки в составе заказа при данном запросе также исправляются автоматически, информации об этом не будет в ответе на запрос.
region	ДА	число, 1–999	Код региона доставки.
zip_code	нет	код из 6 цифр	Почтовый индекс. Используется только в случае доставки «Почтой России». Если не указан, стоимость почтовой доставки рассчитывается без учета возможных сезонных транспортных ограничений (иными словами, после указания почтового индекса может оказаться, что стоимость почтовой доставки выше).
discount	нет	целое число	См. описание одноименного параметра в запросе «Оформление нового заказа».

Параметры ответа:

Имя параметра	Обязательный	Формат, допустимые значения	Описание
delivery	ДА	число, 0–999999	Код способа доставки.
payment	ДА	строка	Коды способов оплаты через запятую.
sum_delivery	ДА	число	Стоимость доставки заказа, руб.

Пример ответа:

<?xml version="1.0" encoding="windows-1251"?>

<answer>

<version>1.3</version>

<datetime>2010-04-26 10:31:15</datetime>

<error>0</error>

<item>

<delivery>0</delivery>

<payment>0,1,2,3,5,6</payment>

<sum_delivery>130</sum_delivery>

</item>

<item>

<delivery>1</delivery>