Инструкция использования сервиса обмена данными

IEK API предназначен товарного наполнения интернет магазина продукцией ГК IEK по протоколу HTTPS.

Протокол и авторизация

Веб-сервисы работают по протоколу HTTPS, для доступа необходима Basic авторизация по логину-паролю, высланному вам в регистрационном письме.

Общий вид и типы запроса

Общий вид запроса на получение данных: https://www.iek.ru/api/{resource}/{params}

Так, например, можно просмотреть сервисные центры (ссылка откроется в новой вкладке): https://www.iek.ru/api/services?format=jsonp

Форматы данных и возвращаемые значения

Данные передаются в форматах JSON, JSONP и XML.

При успешном выполнении операции возвращается HTTP код 200, при ошибках - 4xx (ошибка клиента, то есть с вашей стороны) или 5xx - (ошибка сервера, с нашей стороны). Также передается описание ошибки, например Incorrect login or password обозначает, что при авторизации использован неправильный логин или пароль.

Подробнее о форматах и ошибках

Сервисы

Cервис	Адрес	Название	Описание
products	https://www.iek.ru/api/products	товары	описание, изображение, базовая цена, преимущества и др. информация о товарах
ddp	https://www.iek.ru/api/ddp	группы ддп	структура каталога ДДП в виде дерева (раздел, группа, подгруппа), товары через поле groupId ссылаются на одну из групп ДДП
services	https://www.iek.ru/api/services	сервисные центры	название, город, телефон, адрес, тип сервисного центра
seriesspecifications	https://www.iek.ru/api/seriesspecifications	спецификации серий	название и ссылка на скачивание спецификации серий

Параметры

Параметр	Название	Где применим	Описание	Примеры
format	формат	везде	формат, в котором будут выведены результаты.	https://www.iek.ru/api/ddp?format=jsonp
TM	торговая марка	товары, группы ДДП	фильтр по торговой марке, допустимые значения: IEK, ITK, ONI, IEK серия Home, GENERICA	https://www.iek.ru/api/ddp?TM=ONI
art	артикул	товары	фильтр по артикулу	https://www.iek.ru/api/products?art=MVA21-4-004-D
groupId	группа ДДП	товары	фильтр по группе ДДП, допустимо использовать любую вложенность, например 01, 01.01 или 01.01.01.	https://www.iek.ru/api/products?groupId=01
entity	коммерческая сущность	товары	фильтр по сущностям, которые должны попасть в результат. Если не указывать, выводится только базовая информация: название, артикул, цены.

Товары

Коммерческие сущности

Если в параметре entity не указывать сущность, будет выведена только базовая информация:

https://www.iek.ru/api/products?format=jsonp&art=MVA21-1-D16-B

[{
"art": "MVA21-1-D16-B",
"TM": "IEK",
"groupId": "01.01.02",
"name": "Авт. выкл. ВА47-29М 1P 1,6A 4,5кА х-ка B ИЭК",
"price": 147.02,
"saleprice": 17.56,
"vat": 18,
"vat_included": true,
"roc": 0,
"rrc": 0,
}]

• art - артикул
• TM - торговая марка
• groupId - группа ДДП
• name - название товара
• price - цена в рублях
• saleprice - цена распродажи
• vat - НДС, в %
• vat_included - признак, включен ли НДС в цену (true - включен, false - не включен)
• roc РОЦ
• rrc РРЦ

Например,

• entity=Img выведет информацию по изображениям,
• entity=Img,WiringDiagram выведет информацию по изображениям и схемам подключения,
• entity=all выведет вообще всю доступную информацию.

Полное описание сущностей:

Сущность	Параметр entity
Прайс лист	См. описание полей price, saleprice, vat, vat_included выше
Приложение к гарантийному талону, список СЦ	См. описание сервисных центров
Описание текст	Description
Преимущества Текст	Advantages
Конструктор (совместно используемые устройства)	Constructor
Габаритные чертежи	DimensionDrawing
Схема подключения	WiringDiagram
Изображение товара	Img
3D модели	Models3d
Индивидуальная Упаковка	IndPacking
Гарантийныи срок	LeftPeriod
Срок службы
Аналоги (внутренние)	Analog
Полная ДДП (ДДП 2,0)	См. описание группы ДДП
ДДП дерево IEK
ДДП Описание
ДДП Изображение
Логистические параметры	LogisticParameters
Презентации конкурентных преимуществ	CompetitiveAdvantages
Информация о монтаже	InstallationProduct
Комплектация	Complects
Сервисные центры	ServicesCenter

Если в результатах содержится поле типа file_ref, оно представляет из себя ссылку на файл:

• md5 - md5 хеш содержимого файла
• name - название файла
• size - размер файла в байтах
• uri - сслыка для скачивания

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

curl -s --user your_api_login:your_password 'https://www.iek.ru/api/products?format=jsonp'

Ответ:

[{
"art": "MVA21-1-D16-B",
"TM": "IEK",
"groupId": "01.01.02",
"name": "Авт. выкл. ВА47-29М 1P 1,6A 4,5кА х-ка B ИЭК",
"price": 147.02,
"saleprice": 17.56,
"vat": 18,
"vat_included": true
},{
...

Таким способом мы запросили базовую информацию в формате JSONP по всем товарам ГК IEK.

Пример запроса с фильтром по торговой группе 01.01.02 и выводом информации об аналогах Analog

curl -s --user your_api_login:your_password 'https://www.iek.ru/api/products?format=jsonp&groupId=01.01.02&entity=Analog'

Ответ:

[{
 "art": "MVA21-1-D16-B",
 "TM": "IEK",
 "groupId": "01.01.02",
 "name": "Авт. выкл. ВА47-29М 1P 1,6A 4,5кА х-ка B ИЭК",
 "price": 147.02,
 "saleprice": 17.56,
 "vat": 18,
 "vat_included": true
},{
 "art": "MVA21-4-013-D",
 "TM": "IEK",
 "groupId": "01.01.02",
 "name": "Авт. выкл. ВА47-29М 4P 13A 4,5кА х-ка D ИЭК",
 "price": 350.17,
 "saleprice": 80.41,
 "vat": 18,
 "vat_included": true,
 "Analog": [
	{
	 "analog": "MVA20-4-013-D",
	 "ord": 1,
	 "view": "Двухсторонний аналог",
	 "desc": "новый/старый дизайн"
	}
 ]
},{
...

В этом примере первый товар не имеет аналогов, второй - имеет, и он описан в секции Analog

Группы ДДП

https://www.iek.ru/api/ddp

[{
"TM": "IEK",
"desc": {
"ru": "Автоматические выключатели ВА47-29М предназначены для защиты распределительных и групповых цепей, имеющих различную нагрузку.\n\nАвтоматические выключатели ВА47-29М
рекомендуются к применению в вводно-распределительных устройствах для жилых и общественных зданий и на производстве.\n\nВыключатель награжден золотой медалью 15-й международн
ой выставки \"Электро-2006\" в номинации \"Лучшее электрооборудование\" за решение, обеспечивающее электробезопасность в жилых домах и на производстве, высокие технические и
эргономические характеристики.",
"en": null
},
"file_ref": {
"md5": "8febe3894747440ea56214fb052b64f5",
"name": "5af42b6887de6cd711035349.jpg",
"size": 5821,
"uri": "https://www.iek.ru/api/store/5af42b6887de6cd711035349.jpg"
},
"group": "Автоматические выключатели ВА47-29М",
"groupEn": "Modular circuit breakers VA47-29M",
"groupId": "01.01.02",
"kind": "Модульное оборудование",
"section": "Автоматические выключатели"
},{
...

Сервисные центры

https://www.iek.ru/api/services

[{
"address": "100000, г. Караганда, ул. Комиссарова, д. 28, кв. 2",
"city": "Караганда",
"name": "Artson Service",
"phone": "(7212) 44-54-70",
"type": "СЦ по обслуживанию стабилизаторов СНИ и СНР"
},{
...

Спецификации серий

https://www.iek.ru/api/seriesspecifications

[{
 "file_ref": {
  "md5": "79ec85fef583a5dfe14a2fc1874ce9a9",
  "name": "5b30a6351e6b9a50cc96c28f.xlsx",
  "size": 11257,
  "uri": "https://www.iek.ru/api/store/5b30a6351e6b9a50cc96c28f.xlsx"
 },
 "pubName": "DIY_max_plastikovie boksi_polka"
}
...

Виджет конфигураторов IEK

Для открытия конфигуратора IEK на странице нужно:

• Подключить скрипт <script src="https://www.iek.ru/js/iek-configurator-widget.source.js"></script>
• Инициализировать объект виджета, например: var widget = new IekConfiguratorWidget();
• Привязать вызов метода widget.open(type) к любому событию на странице, например: <button onclick="widget.open(1)">Открыть</button>
  где type - тип конфигуратора:
  1 - Конфигуратор стабилизаторов
  2 - Конфигуратор КНС
  3 - Конфигуратор УЭРМ
  

Название	URL
Конфигуратор стабилизаторов	<button onclick="widget.open(1)">Открыть</button> Открыть
Конфигуратор КНС	<button onclick="widget.open(2)">Открыть</button> Открыть
Конфигуратор УЭРМ	<button onclick="widget.open(3)">Открыть</button> Открыть
Калькулятор освещенности	<button onclick="widget.open(5)">Открыть</button> Открыть
Конфигуратор подбора климатического оборудования iek	<button onclick="widget.open(6)">Открыть</button> Открыть
Конфигуратор металлических оболочек iek	<button onclick="widget.open(7)">Открыть</button> Открыть
Конфигуратор подбора электротехнических шкафов FORMAT IEK	<button onclick="widget.open(9)">Открыть</button> Открыть
Конфигуратор подбора выключателя-разъединителя ВР32И	<button onclick="widget.open(10)">Открыть</button> Открыть
Конфигуратор стабилизаторов напряжения IEK	<button onclick="widget.open(11)">Открыть</button> Открыть
Конфигуратор аксессуаров к металлическим оболочкам iek	<button onclick="widget.open(13)">Открыть</button> Открыть
Конфигуратор металлических оболочек iek	<button onclick="widget.open(14)">Открыть</button> Открыть
Конфигуратор подбора климатического оборудования iek	<button onclick="widget.open(15)">Открыть</button> Открыть
Конфигуратор подбора электротехнических шкафов FORMAT IEK	<button onclick="widget.open(16)">Открыть</button> Открыть
Конфигуратор УЭРМ	<button onclick="widget.open(17)">Открыть</button> Открыть
Конфигуратор подбора аксессуаров к пластиковым КНС	<button onclick="widget.open(21)">Открыть</button> Открыть
Конфигуратор подбора БАП	<button onclick="widget.open(26)">Открыть</button> Открыть