Описание работы web-сервиса

Web-сервис позволяет подключить ваш интернет ресурс к нашей системе. Это позволит в автоматическом режиме получить список доступных предложений по заданному артикулу, отправить в корзину и разместить заказ на нашем портале. Для подключения web-сервиса, вам необходимо связываться с своим менеджером и сообщить ему ip адрес(а) с которых будет происходить подключение. Менеджер отправит в техническую службу вашу заявку и после подтверждения, сервис будет доступен для использования.

Адрес для работы с web-сервисом: https:/api.***.ru
Обмен информации производится в формате JSON c помощью POST запросов.
Формат запроса:
{method: команда,
login: логин,
password : пароль,
request: {запрос}
}

запрос - массив параметров для каждой команды.
Ответ от сервера так же приходит в формате JSON, структура ответа зависит от команды (method).

Описание команд:

Пример:

• brands_by_number. Получить список производителей по номеру детали.
  Параметр запроса - number (номер детали).
  Ответ в виде JSON массива, каждый элемент содержит следующие поля:
  "brand" - наименование производителя
  "brand_id" - внутренний код производителя
  "partname" - название детали
  пример на php:
  

  $request = array(
        'method' => 'brands_by_number',
        'login' => 'partner',
        'password' => 'partner',
        'request' => array('number'=> '22177')
        );
  $post = json_encode($request);      
  $ch = curl_init('https://api.***.ru');
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, $post);
  curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
  curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
  curl_setopt($ch, CURLOPT_HTTPHEADER,array('Content-Type: application/json'));
  $data = curl_exec($ch);
  if (empty($data)) {
  	die(curl_error($ch));
  }
  curl_close($ch);
  var_dump($data);
  
  ответ от сервера :
  string(183) "[{"brand":"KILEN","brand_id":"839","partname":"Пружина подвески Fr RE Megane 97-99\/Scenic I99-03"},{"brand":"SPIDAN","brand_id":"1262","partname":"GELENKSATZ SUBARU"}]"
  

• price. Выдает список предложений по заданному номеру.
  Формат запроса (request):
  'number' - искомый номер;
  'brand_id' - код производителя (необязательный, в случае отсуствия выдаст по всем производителям);
  'cross' - выводить аналоги/замены по заданному номеру. 0 - не выводить аналоги, 1 - вывести замены/аналоги.
  
  Ответ - список элементов, поля каждого элемента:
  "supplier_id" - внутренний код поставщика;
  "Brand" - прозводитель;
  "number" - номер;
  "Partname" - наименование детали;
  "qty" - доступное количество к заказу;
  "cost"- цена в рублях;
  "dlv_min_days" - минимальный срок поставки, дней;
  "dlv_max_days" - максимальный срок поставки, дней;
  "brand_id" - код производителя;
  "min_qty" - минимальное кол-во к заказу(партия);
  "cross" - признак замены (0 - запрошенный номер, 1 - аналог/ замена).
  Пример:
  

  $request = array(
  	'method' => 'price',
  	'login' => 'partner',
  	'password' => 'partner',
  	'request' => array('number'=> '3925164J00',
  			   'brand_id' => 51,
  			   'cross' => 1)
  );
  ответ от сервера:
  string(2679) "[{"supplier_id":"1","Brand":"SUZUKI","number":"3925164J00","Partname":"ШТОК АНТЕННЫ","qty":"2","cost":"541.09","dlv_min_days":"1","dlv_max_days":"1","brand_id":"51","min_qty":"1","cross":0},
  {"supplier_id":"4","Brand":"SUZUKI","number":"3925164J00","Partname":"АНТЕННА","qty":"2","cost":"590.63","dlv_min_days":"1","dlv_max_days":"2","brand_id":"51","min_qty":"1","cross":0},
  {"supplier_id":"25","Brand":"SUZUKI","number":"3925164J00","Partname":"Шток антенны (116) 39251-64J00","qty":"7","cost":"610.50","dlv_min_days":"1","dlv_max_days":"3","brand_id":"51","min_qty":"1","cross":0},
  {"supplier_id":"96","Brand":"SUZUKI","number":"3925164J00","Partname":"ШТОК АНТЕННЫ","qty":"3","cost":"649.35","dlv_min_days":"1","dlv_max_days":"2","brand_id":"51","min_qty":"1","cross":0},
  {"supplier_id":"94","Brand":"SUZUKI","number":"3925164J00000","Partname":"АНТЕННА ШТОК\/ROD,ANTENNA","qty":"15","cost":"940.13","dlv_min_days":"2","dlv_max_days":"4","brand_id":"51","min_qty":"1","cross":1},
  {"supplier_id":"372","Brand":"SUZUKI","number":"3925164J00000","Partname":"АНТЕННА ШТОК\/ROD,ANTENNA","qty":"15","cost":"940.13","dlv_min_days":"2","dlv_max_days":"4","brand_id":"51","min_qty":"1","cross":1}]"
  

• add_to_cart. Добавить позицию в корзину.
  Параметры запроса (request):
  'number' - искомый номер;
  'brand_id' - код производителя;
  'supplier_id' - код поставщика;
  'qty'- заказываемое количество, шт.;
  'reference' - ваша дополнительная информация (например внутренний код из вашей системы, для отслеживания заказов).
  Ответ будет содержать сообщение в виде элемента в случае успешного добавления:
  {"success":{"code":0,"message":"Position added to card"}}
  либо ошибку, например:
  {"error":{"code":211,"message":"Positions not found"}
  Список кодов ошибок см. ниже
  Пример:
  

  $request = array(
        'method' => 'add_to_cart',
        'login' => 'partner',
        'password' => 'partner',
        'request' => array('number'=> 'NP1014', 'supplier_id'=>71, 'brand_id'=>668, 'qty'=>4, 'reference'=>'0x1133b5')
        );
  

  Внимание! при повторном вызове команды, количество штук в корзине удвоится.
• list_cart. Получить список товаров из корзины.
  При вызове этой команды параметры (request) не передаются.
  Ответ - список элементов. Поля каждого элемента:
  'row_id' - уникальный номер строки;
  'brand_id' - код производителя;
  'supplier_id' - внутренний код поставщика;
  'brand' - прозводитель;
  'number' - номер;
  'partname' - наименование детали;
  'qty' - заказываемое кол-во, шт.;
  'price' - цена за шт.;
  'reference' - дополнительный код клиента.

$request = array(
      'method' => 'list_cart',
      'login' => 'partner',
      'password' => 'partner'
      );

• del_from_cart. удалить позицию из корзины.
  Параметры запроса (request):
  'row_id' - уникальный номер позиции (из команды list_cart);
  Ответ будет содержать сообщение в виде элемента в случае успешного удаления:
  {"success":{"code":0,"message":"Position added to card"}}
  либо ошибку:
  {"error":{"code":211,"message":"Position(s) not found"}
• create_order. Создать заказ. Отправляет заказ из позиций, находящихся в корзине
  Параметры запроса (request):
  'order_num' - Номер заказа, если параметр пропущен или пустой, номер будет присвоен автоматически
  'notes' - комментарий к заказу.
  Ответ, в случае успешного создания заказа будет в виде:
  {"success":{"code":0,"message":"Order successfully created"}}
  Или вернет ощибку, например: {"error":{"code":310,"message":"Order with a number-date already exist"}
  Внимание! Система не позволяет создавать заказы, с одинаковым номером заказа в течении одних суток.

Ошибки, возращаемые сервером.

Ответ с ошибкой, будет приходить в следуюшем формате:
{"error":{"code":<код>,"message":<сообщение>}
Список возможных ошибок в ответах сервера: