Частые вопросы по API

Прочие инструкции
Получение данных по референсам

Последнее обновление: 23 февраля 2023 г.

Содержание

Метод getdata

Выборка по категориям вложенности

Выборка по уровням COS

Выборка по сериям

Метод getdata

Поддерживаемые параметры: commercialRef, pageSize, page, brand

Метод используется для первоначального, наиболее полного наполнения базы сведениями о продукции и передает следующие данные:

  • Названия референсов
  • Статус референса
  • Принадлежность к тарифу
  • Серии продукции и их id
  • Описание
  • Ключевые слова
  • Коммерческое название
  • Коммерческое описание
  • Изображения - главное и дополнительные
  • Фото 360
  • Сертификаты на продукцию
  • Основные характеристики
  • Дополнительные характеристики:
    • Батареи и продолжительность автономной работы
    • Вход
    • Выход
    • Защита от всплесков напряжения и фильтрация шумов
    • Коммуникационные средства и средства администрирования
    • Общие
    • Параметры окружающей среды
    • Соответствие
    • Физические параметры
  • Etim характеристики версии 7 - в соответствии с международной классификацией
  • Категория товара (бизнес, категория, подкатегория, Range)
  • Продуктовая иерархия товара
  • Каталоги
  • Техническая документация

Для получения сведений используется метод getdata. По умолчанию возвращается список по первым 50 референсам из базы данных.

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

https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}

Пример выдачи в XML:

<reference>
    <commercialRef>C9F34106</commercialRef>
    <brand>Systeme Electric (ранее Schneider Electric)</brand>
    <keywords>
       <item>акти9</item>
    </keywords>
    <update_date>12.06.2023 00:12:29</update_date>
    <StatusRef>В ассортименте</StatusRef>
    <close_date>10.08.2023</close_date>
    <Substitution>
        <newReference>
            <NewCommercialReference>A9A15212</NewCommercialReference>
            <QuantityOld>1</QuantityOld>
            <QuantityNew>1</QuantityNew>
            <SubstitutionBeginning>15.02.2021</SubstitutionBeginning>
        </newReference>
    </Substitution>
    <description>City9 Set Автоматический выключатель (АВ) С 6А 1P 4.5kA 230В</description>
    <eComProductTitles/>
    <eComeProductDescriptions> Автоматический выключатель серии City9 Set Systeme Electric, 1-полюсный,
        номинальный ток 6 А, характеристика С, Icn = 4.5 кА. Применяется в электрических сетях
        напряжением 230 В. Предназначен для защиты от перегрузок и токов короткого замыкания.
    </eComeProductDescriptions>
    <countries>
        <countries>
            <country>Китай</country>
            <country_code>CN</country_code>
        </countries>
    </countries>
    <tariff>
        <min_order_quantity>12</min_order_quantity>
        <value>55994</value>
        <description>Москва (Лобня, RU01)</description>
    </tariff>
    <images>
        <image>
            <url>https://static-pcsp.systeme.ru/image/SAe_7Cf0t_Ti7Y_S63d8c85151615.jpeg</url>
            <hash>6da07c71c78e13968857336222c26a5c5e933a9a</hash>
            <is_main>1</is_main>
            <size>72343</size>
            <type>jpeg</type>
            <update_date>31.01.2023 10:53:35</update_date>
        </image>
    </images>
    <characteristics>
        <characteristic>
            <type>Гарантия на оборудование</type>
            <name>Гарантия</name>
            <value>Срок гарантии на данное оборудование составляет 3 года</value>
            <update_date>07.08.2023 13:01:02</update_date>
        </characteristic>
    </characteristics>
    <certificates>
        <certificate>
            <name>ЕАЭС RU С-CN.НВ26.В.02514_22</name>
            <filename>ЕАЭС RU С-CN.НВ26.В.02514_22.pdf</filename>
            <url>https://api.systeme.ru/certificates/default/download/2879</url>
            <extension>pdf</extension>
            <types>
                <type>
                    <name>С-ТР ТС-НВО</name>
                    <description>Сертификат соответствия требованиям Технического регламента Таможенного
                    союза ТР ТС 004/2011 "О безопасности низковольтного оборудования"
                    </description>
                 <type/>
                 <type>
                        <name>С-ТР ТС-НВО</name>
                        <description>Сертификат соответствия требованиям Технического регламента Таможенного
                    союза ТР ТС 004/2011 "О безопасности низковольтного оборудования"
                 <type/>
            </types>
            <preview_img>
                https://static-pcsp.systeme.ru/media_preview/certificates/68mkdAXRJk0TmJlGQRy.jpg
            </preview_img>
            <hash>86494bd13dc511b208a0d3aaac69ead4aa65f3b8</hash>
            <status>в наличии</status>
            <start_date>20.12.2022 03:00:00</start_date>
            <ended_date>19.12.2027 03:00:00</ended_date>
            <update_date>21.12.2022 17:57:16</update_date>
            <keywords>
                <keyword>дифференциальный блок</keyword>
                <keyword>compact</keyword>
            </keywords
        </certificate>
    </certificates>
    <photo360>
        <url>https://api.systeme.ru/player/embed?ref=C9F34106</url>
        <update_date>14.11.2023 15:10:29</update_date>
    </photo360>
    <videos>
        <video>
            <url>https://www.youtube.com/watch?v=icabd-y4veo</url>
            <title>Заголовок</title>
            <description>Описание видео</descriptionl>
            <update_date>21.08.2023 16:22:30</update_date>
        </video>
    </videos>
    <etim>
        <etim7>
            <class>
                <id>EC000042</id>
                <descriptionRu>Модульный автоматический выключатель (автомат)</descriptionRu>
            </class>
            <features>
                <feature>
                    <id>EF005474</id>
                    <description>Степень защиты (IP)</description>
                    <value>EV006405</value>
                    <valueDescriptionRu>IP20</valueDescriptionRu>
                    <valueDescriptionEn>IP20</valueDescriptionEn>
                </feature>
                <feature>
                    <id>EF000187</id>
                    <description>Тип напряжения</description>
                    <value>EV000460</value>
                    <valueDescriptionRu>AC</valueDescriptionRu>
                    <valueDescriptionEn>AC</valueDescriptionEn>
                </feature>
                <feature>
                    <id>EF000228</id>
                    <description>Номин. напряжение</description>
                    <value>230</value>
                    <valueDescriptionRu/>
                    <valueDescriptionEn/>
                </feature>
                <feature>
                    <id>EF000416</id>
                    <description>Частота</description>
                    <value>50</value>
                    <valueDescriptionRu/>
                    <valueDescriptionEn/>
                </feature>
                <feature>
                    <id>EF000218</id>
                    <description>Глубина установочная (встраив.)</description>
                    <value>45</value>
                    <valueDescriptionRu/>
                    <valueDescriptionEn/>
                </feature>
                <feature>
                    <id>EF002950</id>
                    <description>Модульная ширина (общ. кол-во модульных расстояний)</description>
                    <value>1</value>
                    <valueDescriptionRu/>
                    <valueDescriptionEn/>
                </feature>
                <feature>
                    <id>EF000227</id>
                    <description>Номин. ток</description>
                    <value>6</value>
                    <valueDescriptionRu/>
                    <valueDescriptionEn/>
                </feature>
                <feature>
                    <id>EF000889</id>
                    <description>Характеристика срабатывания (кривая тока)</description>
                    <value>EV000084</value>
                    <valueDescriptionRu>C</valueDescriptionRu>
                    <valueDescriptionEn>C</valueDescriptionEn>
                </feature>
            </features>
        </etim7>
    </etim>
    <documents>
        <document>
            <type>Техническая документация</type>
            <url>https://static-pcsp.systeme.ru/media/63ecd0fbSBa_rGkPYEYryLTeUrF1_1676464375.pdf</url>
            <size>331165</size>
            <fileType>pdf</fileType>
            <hashSum>89f2b5671937eaf67e36a4a3dcf5bee6d884088a</hashSum>
            <preview_img>
                https://static-pcsp.systeme.ru/media_preview/media/rYPTuKagb8ECCW.jpg
            </preview_img>
            <update_date>15.02.2023 15:32:15</update_date>
            <keywords>
                <keyword>Модульное оборудование</keyword>
            </keywords>
        </document>
    </documents>
    <series>
        <id>399</id>
        <name>City9 SET</name>
    </series>
    <cos_hierarchies>
        <cos_hierarchy>
            <cos1>15PVM</cos1>
            <cos1_description>Power Медиум</cos1_description>
            <cos2>C94</cos2>
            <cos2_description>City9 SET</cos2_description>
            <cos3>M45</cos3>
            <cos3_description>City9 Автоматические выключатели 4,5кА</cos3_description>
            <update_date>30.08.2023 10:27:09</update_date>
        </cos_hierarchy>
    </cos_hierarchies>
</reference>


Описание тегов:

commercialRef - наименование референса.

brand - бренд товара.

Поддерживается сортировка товара по бренду, для этого используйте: https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&brand={ID-бренда}

Чтобы получить список брендов с их идентификаторами (ID) используйте метод API getbrands https://api.systeme.ru/new-api/XML/getbrands?accessCode={YourApiToken}

update_date - дата обновления товара.

StatusRef - может иметь значение "В ассортименте" и "Выведен из ассортимента". Более полную информацию по референсу, который выведен из ассортимента можно получить в метода Замены референсов.

close_date - дата снятия с производства.

tariff - информация о тарифе, включает информацию:
min_order_quantity - минимальное количество для заказа value - идентификатор склада, допустимы следующие значения: 55995 (Лобня) и 55994 (Екатеринбург) description - описание склада

description - описание товара, на русском языке. Для корректной обработки символов-мнемоников используется экранирование.

eComProductTitles - коммерческое название.

eComeProductDescriptions - коммерческое описание.

images - ссылки на изображения референса с указанием расширений type и размеров size в байтах. У референса может быть несколько изображений, одно из них главное (основное). Если основное изображение определено, то у него появляется тег is_main со значением 1. 

<image>
    <url>
        https://static-pcsp.systeme.ru/image/50732/TMcGh147.jpeg
    </url>
    <hash>2e426b145f01bc3667a4224f0e246b392a7faa7b</hash>
    <is_main>1</is_main>
    <size>991557</size>
    <type>jpeg</type>
</image>


Такие изображения можно использовать в карточках товара на сайтах в качестве основных. По умолчанию все изображения хранятся в jpg, одно изображение может иметь несколько версий по размеру и весу.

characteristic - основные характеристики референса, список может сильно отличаться между типами продукции.

certificates - список сертификатов на продукцию в виде ссылок на документы формата pdf. Передается информация о статусе сертификации status и сроках действия сертификата (дата начала действия start_date, дата завершения действия ended_date и дате обновления информации update_date.

photo360 - ссылка на плеер с фото 360. Плеер доступен по протоколу https, поэтому на сайтах с https могут возникнуть ошибки в браузере (проблемы с безопасностью). В среднем общий вес фото составляет 1.5Мб, размер кадра 1000 пикселей по максимальной стороне. (Подробнее о передаче списка фотограий в отдельном методе).

videos - ссылки на видеоролики в youtube

etim - описание референса на русском языке по стандарту Etim версий 7 . В выдаче всегда отображается наиболее приоритетная версия Etim 7. Если референс имеет несколько версий Etim, все они отображаются в порядке понижения версий (7). Рекомендуется всегда забирать самую последнюю версию.

<etim>
    <etim7>...</etim7>   
</etim>

Все классы Etim (EC), свойства (EF), значение (EV) передаются с их кодами и описаниями на русском языке.

Выборка по категориям вложенности

generalHierarchies - категория вложенности товара:

<generalHierarchies>
    <generalHierarchy>
        <business>...</business>
        <category>...</category>
        <subcategory>...</subcategory>
        <range>...</range>
    </generalHierarchy>
    <generalHierarchy>
        <business>...</business>
        <category>...</category>
        <subcategory>...</subcategory>
        <range>...</range>
    </generalHierarchy>
</generalHierarchies>

Поддерживается фильтрация по параметрам бизнес, категорий, подкатегорий и range:
business - фильтр по бизнесу;

category - фильтр по категории;

subcategory - фильтр по подкатегории;

range - фильтр по range.

Пример:
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&business={ID бизнеса}

https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&category={ID категории}

https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&subcategory={ID подкатегории}

https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&range={ID range}

Для получtния ID бизнесов, категорий, подкатегорий и range используйте отдельный метод API:
Бизнесы https://api.systeme.ru/new-api/XML/getbusiness?accessCode={YourApiToken}
Категории https://api.systeme.ru/new-api/XML/getcategories?accessCode={YourApiToken}
Сабкатегории https://api.systeme.ru/new-api/XML/getsubcategories?accessCode={YourApiToken}
Range https://api.systeme.ru/new-api/XML/getranges?accessCode={YourApiToken}

Выборка по уровням COS

cos_hierarchies - продуктовая иерархия товара

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

Персональный процент скидки необходимо добавлять к тарифной стоимости на своей стороне. По API получить персональные цены нельзя.

Пример:
https://api.systeme.ru/new-api/XML/getcos?accessCode={YourApiToken}&cos1=15RTP&cos2=AC9&cos3=RTD

COS имеет 3 уровня иерархии: COS1, COS2, COS3 и полностью соответствует Коллекции, Линейки и Сублинейки в тарифе. Каждый уровень имеет свой уникальный код, по которому можно применить фильтр. Коды и уровень COS изначально определены у референса:

<cos_hierarchies>
    <cos_hierarchy>
        <cos1>15RTE</cos1>
        <cos1_description>Ритейл Эконом</cos1_description>
        <cos2>BLA</cos2>
        <cos2_description>ЭУИ BLANCA</cos2_description>
        <cos3>FMS</cos3>
        <cos3_description>Механические функции, открытый</cos3_description>
        <update_date>09.03.2023 15:07:58</update_date>
    </cos_hierarchy>
</cos_hierarchies>

COS1 на примере имеет код 15RTE, который и подставляется в фильтр. Для более удобного и визуального представления этих данных можно использовать фильтр в каталоге https://api.systeme.ru/, выбрав вкладку "Тарифное". Получив необходимый набор референсов, эти коды COS можно перенести в запрос API, тем самым получив тот же самый набор референсов в выдаче.

Референсы могут иметь не все 3 уровня COS, а только один или два, начиная с первого уровня. Это является нормой.

Screenshot_11.jpg

documents - ссылки на документы и каталоги в pdf

series - id и наименование серии. Значение id может использоваться для получения сведений о всех референсах, которые в ней содержатся.

Если в выдаче тег не содержит информацию, значит ее нет в базе данных. Чтобы убедиться, что это не ошибка выдачи, можно сверить данные в веб-версии базы api.systeme.ru, они также должны отсутствовать.
Если у вас уже имеется интеграция с API, но при этом информация по референсам не полная, проверьте через какой метод ваша система забирает данные. Возможно, это устаревший метод getbasicdata, который передает только основную информацию. Рекомендуем обновить ваш код для использования метода getdata, иначе есть риск получения не полных данных или их полное отсутствие.

Выборка по сериям

API позволяет получать продуктовые данные референсов по сериям. Например, нужно получить все данные референсов, которые относятся к Blanca. Для этого в запрос подставляется id серии и в ответ приходят данные по всем референсам Blanca.

В одном запросе можно указать только один идентификатор серии, поиск по нескольким id не поддерживается.

Пример запроса:
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&series=571

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

<content>
    <result>success</result>
    <data>
        <reference>
            <commercialRef>BLNRS000016</commercialRef>
            <tariff>
                <value>moscow</value>
                <description>ШЭ (Москва)</description>
            </tariff>
            <description>
                BLANCA С/У РОЗЕТКА без заземления без шторок 16А, 250В, АНТРАЦИТ
            </description>
            <images>
                <image>
                    <url>
                        https://static-pcsp.systeme.ru/image/184112/2BEZYOpN.jpeg
                    </url>
                    <size>659046</size>
                    <type>jpeg</type>
                </image>
                <image>
                    <url>
                        https://static-pcsp.systeme.ru/image/184112/Hz-EGgqZ.jpeg
                    </url>
                    <size>158193</size>
                    <type>jpeg</type>
                </image>
            </images>
            <characteristics/>
        </reference>
    </data>
</content>


Выдача идентична стандартной выдаче метода getdata, в данном случае используется лишь фильтр для вывода данных.

Список идентификаторов всех серий можно получить через GET запрос:
https://api.systeme.ru/new-api/XML/getseries?accessCode={YourApiToken}

Структура вложенности серий и референсов в БД API отличается от сайта se.com. На данный момент нет списка соответствия иерархий меню между этими платформами. Это необходимо делать самостоятельно.
В текущей версии вложенности БД API референсы одной серии могут принадлежать различным id. Например, серии Blanca и ЭУИ Blanca имеют разные id, но содержат все референсы Blanca. Один референс может иметь только одну серию, поэтому необходимо проверять в каких id они могут содержаться. Как правило, эти серии созвучны между собой.

В будущем планируется унификация структуры меню между двумя платформами и группирование референсов внутри одной серии. Следите за обновлениями.

Ошибка в тексте?

Выделите ее и нажмите

Ctrl + Enter

Продолжая просмотр сайта www.api.systeme.ru я соглашаюсь с использованием файлов cookie владельцем сайта в соответствии с «Политикой в отношении файлов cookie», в том числе на передачу данных, указанных в Политике, третьим лицам - статистическим службам сети Интернет.