Документация для разработчиков "WEB-Service" REST API

Общая информация

Доступ к публичному API осуществляется посредством HTTP-запросов и реализован с использованием принципов REST. Базовым URI для веб-службы является:

                
                     https://b2motor.ru/api/webservice/
                
                

Обмен осуществляется в кодировке UTF-8.

Для отладки вы можете воспользоваться расширением Advanced REST Client для обозревателя Google Chrome.

Запрос

Запросы на получение и запись данных осуществляются с помощью HTTP-методов GET и POST соответственно. В структуре сервиса имеется понятие операции. Операция указывается в качестве пути в URL. Параметры передаются как строка запроса HTTP (GET) или данными POST. Большая часть операций исполняется от имени конкретного пользователя и требует идентификации с помощью параметров userlogin (имя пользователя в системе) и userpsw (md5-хэш пароля пользователя). Md5-хэш можно сгенерировать выполнением функции (большая часть языков программирования имеет данную функцию в своем арсенале), либо воспользоваться online-генератором. Каждая операция может иметь список дополнительных параметров, определяемых контекстом операции. Например, вызов операции "Поиск детали по номеру" может выглядеть следующим образом:

                
                     https://b2motor.ru/api/webservice/search/product/?userlogin=username&userpassw=md5pass&article=24-1106010&brand=ШАНС ПЛЮС
                
                

Ответ

В случае успешного исполнения операции, веб-служба вернет ответ с HTTP-кодом 200 и телом ответа в виде JSON. Формат ответа определяется каждой операцией. Пример результата успешного выполнения запроса:

                
                    [
  	{
  		"brand": "Hepu",
  		"article": "P999",
  		"articleFix": "P999",
  		"articleId": "2854918",
  		"description": "Антифриз [синий] 1,5л.",
  		"availability": "-1",
 		"deliveryPeriod": 3,
		"price": 231,
 		"weight": "0"
 	},
 	{
 		"brand": "Febi",
 		"article": "01089",
 		"articleFix": "01089",
 		"description": "Антифриз 1.5 л синий",
 		"availability": "1943",
 		"deliveryPeriod": 3,
 		"price": 233,
 		"weight": "1.76"
 	},
 	{
 		"brand": "Vaico Vemo",
 		"article": "V600020",
 		"articleFix": "V600020",
 		"description": "Антифриз g-11 1.5л. концентрат",
 		"availability": "-2",
 		"deliveryPeriod": 3,
 		"price": 235,
 		"weight": "0"
 	}
 ]
                
                

Любой ответ с HTTP-кодом 400 и более является ошибочным, в теле содержит код ошибки и, как правило, текстовое сообщение описывающее причины возникшей ошибки также в виде JSON. Пример сообщения об ошибке:

                
                {
                    "errorCode": 102,
                    "errorMessage": "User Authentication Error"
                }
                
                

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

Поиск детали по номеру и бренду

Операция: search/product/
Метод: GET

Осуществляет поиск по номеру детали и бренду. Возвращает массив найденных деталей. Так как один и тот же производитель может иметь несколько общепринятых наименований (например, GM и General Motors), система постарается это учесть, используя собственную базу синонимов брендов.

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

Пример запроса

                
            https://b2motor.ru/api/webservice/search/product/?article=24-1106010&brand=ШАНС ПЛЮС&userlogin=username&userpassw=md5pass
                
                

Поля ответа

Метод возвращает массив объектов вида:

Добавление товаров в корзину

Операция: basket/add/
Метод: POST

Метод добавляет товар в корзину. Обязательно необходимы бренд, артикул, код товара, идентификатор склада и идентификатор поставщика. При добавлениипозиции, которая уже была ранее добавлена в корзину значение quantity будет прибавлено к существующему.

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

Расшифровка параметра positions

Пример запроса

                
                    https://b2motor.ru/api/webservice/basket/add/?userlogin=username&userpassw=md5pass
                
                

                
                      {
  	"positions":
  	    [
  		  {
  			"brand": "САЗ",
  			"article": "2121-2915402",
  			"distributorID": "1",
  			"storeID": "0007",
  			"quantity": "6",
 			"price": "427",
 			"code": "078733"
 		  },
 		  {
 			"brand": "AVS",
 			"article": "A78220S",
 			"distributorID": "1",
 			"storeID": "0999",
 			"quantity": "2",
 			"price": "175",
 			"code": "701072"
 		  }
 	    ]
 }
                
                

Поля ответа

Метод возвращает объект вида:

Расшифровка параметра positions

Изменение количества товаров в корзине

Операция: basket/edit/
Метод: GET

метод меняет количество товара на quantity

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

Пример запроса

                
                   https://b2motor.ru/api/webservice/basket/edit/?basketId=167846&quantity=12&userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Удаление элементов корзины

Операция: basket/delete/
Метод: GET

метод удаляет один или несколько эллементов корзины

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

Пример запроса

                
                  https://b2motor.ru/api/webservice/basket/delete/?basketId[0]=167846&basketId[1]=167847&userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Расшифровка параметра positions

Полная очистка корзины

Операция: basket/clear/
Метод: GET

метод удаляет ВСЕ эллементы корзины

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

Пример запроса

                
                 https://b2motor.ru/api/webservice/basket/clear/?userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Получение списка товаров в корзине

Операция: basket/list/
Метод: GET

метод удаляет ВСЕ эллементы корзины

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

Пример запроса

                
                https://b2motor.ru/api/webservice/basket/list/?userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Расшифровка параметра positions

Оформление корзины в заказ

Операция: orders/add/
Метод: GET

метод добавляет эллементы корзины в заказ (возможно частичное оформление)

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

Пример запроса

                
               https://b2motor.ru/api/webservice/orders/add/?userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Узел orders возвращает набор объектов вида

Расшифровка параметра positions

Список заказов/заказ детально

Операция: orders/list/
Метод: GET

метод добавляет эллементы корзины в заказ (возможно частичное оформление)

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

Пример запроса на полный список заказов

                
               https://b2motor.ru/api/webservice/orders/list/?userlogin=username&userpassw=md5pass
               https://b2motor.ru/api/webservice/orders/list/?format=1&userlogin=username&userpassw=md5pass
                
                

Пример запроса на деталировку заказа

                
              https://b2motor.ru/api/webservice/orders/list/?number=957831&userlogin=username&userpassw=md5pass
                
                

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

Метод возвращает объект вида:

Расшифровка orders

Расшифровка параметра positions