Введение в API PCSP

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

Содержание

Описание базы данных

Структура и синтаксис запросов

Описание параметров

Веб-версия api.systeme.ru

Описание базы данных

База данных продукции Systeme Electric, Dekraft, Schneider Electric насчитывает информацию более чем о 200 000 референсов (или “артикулов”). Основная информация структурирована в соответствии со стандартом Etim версий 5, 6 и 7. Дополнительная информация имеет свои собственные классификацию и структуру данных, простые для использования.

Надо отметить, что наиболее полная информация содержится по тарифному периметру. Для них всегда есть информация о цене и остатках. Для всех остальных информации может быть значительно меньше или отсутствовать вообще. Например, чтобы узнать цену или наличие у нетарифных референсов, необходимо запрашивать эту информацию отдельно у вашего менеджера со стороны Systeme Electric. Для таких референсов через API эти данные не передаются.

Информация по референсам (в основном тарифные) обновляется ежедневно и содержит в себе:

  • Названия референсов
  • Бренд
  • Категории
  • Принадлежность к тарифу и цены
  • Описания
  • Изображения - главное и дополнительные
  • Сертификаты на продукцию для разных стран
  • Основные характеристики
  • Ссылку на плеер фото 360
  • Фото в интерьере
  • Статьи
  • Видео
  • Коммерческое название
  • Коммерческое описание
  • Etim характеристики версий 5, 6 и 7 - в соответствии с международной классификацией
  • Каталоги и дополнительные материалы
  • Логистические данные
  • Дополнительные характеристики
  • Информацию о распродажах
  • Остатки
  • Ключевые слова
  • Связанные референсы


Получение данных представляет собой работу с REST API через GET-запросы по протоколу HTTPS. Ответ приходит в виде структурированных сообщений форматов XML или JSON, в кодировке UTF-8.

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

<content>
    <result>success</result>
    <data>
        <reference>
            <commercialRef>11001DEK</commercialRef>
            <brand>DEKraft</brand>
            <update_date>03.01.2023 09:57:10</update_date>
            <StatusRef>В ассортименте</StatusRef>
            <close_date/>
            <description>Авт. выкл. 1Р 1А х-ка B ВА-101 4,5кА</description>
            <eComProductTitles/>
            <eComeProductDescriptions>Автоматический выключатель серии ВА-101 DEKraft; 1P; номинальный
                ток 1 А; характеристика B; отключающая способность 4,5 кА. 5 монолитных заклепок
                повышают прочность корпуса аппарата. 
            </eComeProductDescriptions>
            <tariff>
                <min_order_quantity>12</min_order_quantity>
                <value>55994</value>
                <description>Москва (Лобня, RU01)</description>
            </tariff>
            <images>
                <image>
                    <url>https://static-pcsp.systeme.ru/image/ArmdVcZzrrf9b1655290292.jpeg</url>
                    <hash>2e426b145f01bc3667a4224f0e246b392a7faa7b</hash>
                    <is_main>1</is_main>
                    <size>64236</size>
                    <type>jpeg</type>
                    <update_date>15.06.2022 13:51:32</update_date>
                </image>
            </images>
            <characteristics>
                <characteristic>
                    <type>Гарантия на оборудование</type>
                    <name>Гарантия</name>
                    <value>Срок гарантии на данное оборудование составляет 3 года с момента 
                        отгрузки со склада Систэм Электрик.
                    </value>
                    <update_date>07.08.2023 13:00:56</update_date>
                </characteristic>
            </characteristics>
            <certificates>
                ...
            </certificates>
            <photo360>
                <url/>
                <update_date/>
            </photo360>
            <videos>
                <video>
                    <url>https://www.youtube.com/watch?v=at9bjAwB1Xc</url>
                    <title>DEKraft Автоматические выключатели серии ВА-101 4.5кА</title>
                    <description>
                        Представляем вам серию автоматических выключателей ВА-101.
                    </description>
                    <update_date>03.02.2023 16:20:49</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>
                    </features>
                </etim7>
            </etim>
            <documents>
                <document>
                    <type>Техническая документация</type>
                    <url>https://api.systeme.ru/product/media/download/988101</url>
                    <size>4833511</size>
                    <fileType>pdf</fileType>
                    <hashSum>bf71f6c0a7ef7f8ef8a8edf83f6a31be9b5d7aa2</hashSum>
                    <preview_img>
                        https://static-pcsp.systeme.ru/media_preview/media/hACOr2PUAekNRY.jpg
                    </preview_img>
                    <update_date>03.08.2023 09:39:03</update_date>
                    <keywords>
                        <keyword>автоматические выключатели</keyword>
                    </keywords>
                </document>
            </documents>
            <series>
                <id>228</id>
                <name>DEKraft Модульные автоматы 4,5кА ВА-101</name>
            </series>
            <cos_hierarchies>
                <cos_hierarchy>
                    <cos1>15PVB</cos1>
                    <cos1_description>Power Базовая</cos1_description>
                    <cos2>DM1</cos2>
                    <cos2_description>DEKraft Модульные автоматы 4,5кА ВА-101</cos2_description>
                    <cos3>BAS</cos3>
                    <cos3_description>базовая функция</cos3_description>
                    <update_date>22.11.2023 17:40:24</update_date>
                </cos_hierarchy>
            </cos_hierarchies>
        </reference>
    </data>
</content>


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

{
  "result": "success",
  "data": [
    {
      "commercialRef": "11001DEK",
      "brand": "DEKraft",
      "update_date": "03.01.2023 09:57:10",
      "StatusRef": "В ассортименте",
      "close_date": null,
      "description": "Авт. выкл. 1Р 1А х-ка B ВА-101 4,5кА",
      "eComProductTitles": "",
      "eComeProductDescriptions": "Автоматический выключатель серии ВА-101 DEKraft; 1P;",
      "tariff": {
        "min_order_quantity": 12,
        "value": "55994",
        "description": "Москва (Лобня, RU01)"
      },
      "images": [
        {
          "url": "https://static-pcsp.systeme.ru/image/ArmdVcZzrrf0292.jpeg",
          "size": 64236,
          "type": "jpeg",
          "hash": "2e426b145f01bc3667a4224f0e246b392a7faa7b",
          "update_date": "15.06.2022 13:51:32",
          "is_main": "1"
        }
      ],
      "characteristics": [
        {
          "type": "Гарантия на оборудование",
          "name": "Гарантия",
          "value": "Срок гарантии на данное оборудование составляет 3 года.",
          "update_date": "07.08.2023 13:00:56"
        }
      ],
      "certificates": [
        {
          "name": "ЕАЭС N RU Д-CN.РА07.В.96306_22",
          "filename": "ЕАЭС N RU Д-CN.РА07.В.96306_22.pdf",
          "url": "https://api.systeme.ru/certificates/default/download/2793",
          "extension": "pdf",
          "type": {
            "name": "Д-ТР ЕАЭС-RoHS",
            "description": "Декларация о соответствии требованиям Технического регламента"
          },
          "preview_img": "https://static-pcsp.systeme.ru/media_preview/certificates/v8lhtjxuF.jpg",
          "status": "в наличии",
          "start_date": "04.11.2022 03:00:00",
          "ended_date": "03.11.2027 03:00:00",
          "update_date": "25.11.2022 17:19:21",
          "keywords": [
            "автоматический выключатель",
            "выключатель автоматический",
            "контакт",
            "контакты"
          ]
        }
      ],
      "photo360": {
        "url": null,
        "update_date": false
      },
      "videos": [
        {
          "url": "https://www.youtube.com/watch?v=at9bjAwB1Xc",
          "title": "DEKraft Автоматические выключатели серии ВА-101 4.5кА",
          "description": "Представляем вам серию автоматических выключателей ВА-101.",
          "update_date": "03.02.2023 16:20:49"
        }
      ],
      "etim": {
        "etim7": {
          "class": {
            "id": "EC000042",
            "descriptionRu": "Модульный автоматический выключатель (автомат)",
            "update_date": "20.06.2019 11:45:56"
          },
          "features": [
            {
              "id": "EF005474",
              "description": "Степень защиты (IP)",
              "value": "EV006405",
              "valueDescriptionRu": "IP20",
              "valueDescriptionEn": "IP20",
              "update_date": "20.06.2019 22:04:55",
              "relation_update_date": "06.07.2021 23:20:11",
              "unit": null
            },
            {
              "id": "EF000187",
              "description": "Тип напряжения",
              "value": "EV000460",
              "valueDescriptionRu": "AC",
              "valueDescriptionEn": "AC",
              "update_date": "20.06.2019 22:04:55",
              "relation_update_date": "06.07.2021 23:20:11",
              "unit": null
            }
          ]
        }
      },
      "documents": [
        {
          "type": "Каталог",
          "url": "https://api.systeme.ru/product/media/download/987994",
          "size": 1765652,
          "fileType": "pdf",
          "hashSum": "7c93776c729acca519714277c0f086d50be8333a",
          "preview_img": "https://static-pcsp.systeme.ru/media_preview/media/JeM6DKDmIywUFVPVt.jpg",
          "update_date": "27.11.2023 20:03:27",
          "keywords": [
            "автомат",
            "ВА-101",
            "Выключатель автоматический"
          ]
        }
      ],
      "series": {
        "id": 228,
        "name": "DEKraft Модульные автоматы 4,5кА ВА-101"
      },
      "cos_hierarchies": [
        {
          "cos1": "15PVB",
          "cos1_description": "Power Базовая",
          "cos2": "DM1",
          "cos2_description": "DEKraft Модульные автоматы 4,5кА ВА-101",
          "cos3": "BAS",
          "cos3_description": "базовая функция",
          "update_date": "22.11.2023 17:40:24"
        }
      ]
    }
  ]
}


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

Структура и синтаксис запросов

В примерах могут встречаться фигурные скобки {}. В синтаксисе эти скобки не используются, все значения необходимо указывать без них.

Пример ссылки для вызова методов:
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}

/new-api - версия API. Старая версия имеет категорию /api и более не поддерживается. Во избежание ошибок настроена принудительная переадресация всех ссылок на новую версию.

/XML - формат выдачи данных. Поддерживаются форматы XML и JSON.

/getdata - наименование используемого метода для получения данных

/?accessCode={} - параметр, передающий ваш API-Token. Токен должен указываться сразу после знака равно = и не иметь пробелов.

В качестве основного параметра используется API-Token, выдаваемый пользователю при регистрации в системе. Без него доступ к API не будет разрешен системой безопасности.

Описание параметров

Каждый метод поддерживает свой собственный список параметров. Этот список обозначается вначале каждого раздела документации.

&page={N} - пагинация, осуществляет переход к указанной странице, где N - ее номер. Общее количество страниц в выдаче системой не определяется (нецелесообразно), поэтому осуществлять перебор данных постранично нужно до тех пор, пока ответ не перестанет возвращать продуктовые данные (выдача станет пустой).

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

&pageSize={N} – задает количество записей в выдаче, где N - числовое значение. По умолчанию большинство методов содержит лимит в 50 записей на страницу. Максимальное значение лимита 50.

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

&commercialRef={N} – запрос данных по конкретному референсу или списку референсов, где N - точное обозначение референса, например GSL000434. Если в качестве значения задается список референсов, то они должны перечисляться через запятую без пробелов: GSL000434,16765,18636. Максимальное значение лимита 50.

Примеры запросов:
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&commercialRef=GSL000434
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&commercialRef=GSL000434,16765,18636

&date={N} – указывает на дату, от которой следует запросить обновленные данные. Параметр поддерживается только методами delta. Формат данных «дд.мм.гггг», например «20.04.2019».

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

Запросы можно строить с использованием нескольких параметров одновременно.

Пример запрос с использованием нескольких параметров:
https://api.systeme.ru/new-api/XML/getdata?accessCode={YourApiToken}&page=2&pageSize=100

Для связи параметров используется знак апмерсанд &. Порядок указания параметров может быть в разной последовательности, на выдачу это не влияет.


&discount=1 - добавляет в выдачу метода getprice информацию о распродаже. Если референс имеет дисконтную цену, то в выдаче появляются теги <discount_start> - дата начала распродажи и <discount_end> - дата завершения распродажи включительно. Цена отображается уже с учетом скидки. Для отключения действия используется значение 0.

Пример запроса информации по скидкам:
https://api.systeme.ru/new-api/XML/getprice?accessCode={YourApiToken}&discount=1

Пример выдачи со скидками:

<reference>
    <commercialRef>A9C62225</commercialRef>
    <description>АВТ. ВЫКЛ. REFLEX iC60N 2П 25A C Ti24</description>
    <series>Acti9_Smartlink</series>
    <price>4432.36</price>
    <date>10.06.2019</date>
    <discount_start>01.06.2019</discount_start>
    <discount_end>31.08.2019</discount_end>
    <unit>за штуку</unit>
</reference>
Крайне не рекомендуется работа с API напрямую. Стройте архитектуру вашего приложения таким образом, чтобы все данные сперва сохранялись в вашей БД, а уже потом использовались вами. В ином случае, излишние прямые запросы к API нагружают сервер, а при его сбое ваше приложение перестанет корректно работать.

Веб-версия api.systeme.ru

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

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

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

Ctrl + Enter

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