ГлавнаяДокументация по YML API

Документация по YML API

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

Конечная точка

Всё взаимодействие с API должно вестись по протоколу HTTPS. Базовый эндпоинт API, относительно которого строятся запросы: https://api.breez.ru/v1/yml/. Используемый HTTP-метод: GET. Параметры запроса передаются в параметрах URL, например: 

GET https://api.breez.ru/v1/yml/?brand=1
В данном случае параметр запроса brand равен 1.

Авторизация

Авторизация происходит посредством Базовой схемы HTTP-аутентификации. Учётные данные для доступа к API передаются с каждым запросом в заголовке Authorization. Заголовок должен иметь следующий формат: 

Authorization: Basic <credentials>
Где <credentials> - это ваши учётные данные, представленные в виде закодированной в Base64 строки вида имя_пользователя:пароль. Например, если ваше имя пользователя username, а пароль password, то строка будет иметь вид username:password. Кодируем её в Base64 и получаем dXNlcm5hbWU6cGFzc3dvcmQ=. Тогда заголовок будет иметь вид 
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
Учётные данные для авторизации можно получить запросом через форму "Запросить ключ" на api.breez.ru.

Формат данных

Данные доступны в формате YML - собственном стандарте Яндекс, который основан на XML. Подробнее о формате можно узнать в официальной документации.

Полная выгрузка

Описание запроса

Данный запрос производится по умолчанию, когда ни один специфичный параметр запроса не указан.

GET https://api.breez.ru/v1/yml/

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

В ответ на данный запрос возвращаются все доступные Категории и Продукты.

<?xml version="1.0" encoding="UTF-8"?>
<yml_catalog date="2023-05-25T14:00+03:00">
    <shop>
        <name>БРИЗ-Климатические системы</name>
        <company>БРИЗ-Климатические системы</company>
        <url>https://breez.ru/</url>
        <categories>
            <category id="1">Кондиционирование</category>
            ...
            <category id="114" parentId="97">BRAND Аксессуары</category>
        </categories>
        <offers>
            <offer id="ABC777/77">
                <name>BRAND Аксессуары BRAND ABC777/77</name>
                <categoryId>114</categoryId>
                <vendor>BRAND</vendor>
                <vendorCode>ABC777/77</vendorCode>
                <description><![CDATA[ <p>Фильтр 2 в 1 механической очистки. Первой...</p> ]]></description>
                <picture>https://images.breez.ru/catalog/brand/accessories/accessory-ABC-777-77.jpg</picture>
                <price>9000</price>
                <currencyId>RUR</currencyId>
                <param name="Бренд" unit="">BRAND</param>
                <param name="Модель" unit="">ABC777/77</param>
                <param name="Применимость к системе" unit="">ABC3000/10 и ABC2000/10</param>
                <param name="Тип картриджа" unit="">Картридж механической очистки</param>
                <param name="Кол-во ступеней фильтрации" unit="">2</param>
                <param name="Ресурс картриджа" unit="л">6000</param>
                <param name="Материал корпуса " unit="">пластик</param>
                <param name="Цвет корпуса" unit="">белый</param>
                <param name="Вес нетто" unit="кг">1.15</param>
                <param name="Вес брутто" unit="кг">1.25</param>
                <param name="Габаритные размеры" unit="мм">100x300x100</param>
                <param name="Ширина" unit="мм">100</param>
                <param name="Высота" unit="мм">300</param>
                <param name="Глубина" unit="мм">100</param>
                <param name="Габаритные размеры упаковки" unit="мм">130x330x130</param>
                <param name="Ширина" unit="мм">130</param>
                <param name="Высота" unit="мм">330</param>
                <param name="Глубина" unit="мм">130</param>
                <param name="Гарантия" unit="мес.">12</param>
                <param name="Страна производства" unit="">Россия</param>
            </offer>
            ...
        </offers>
    </shop>
</yml_catalog>
Параметр Описание
name Название магазина (всегда "БРИЗ-Климатические системы")
company Название компании (всегда "БРИЗ-Климатические системы")
url Адрес сайта (всегда "https://breez.ru/")
categories Содержит элементы category
category Категория доступных в магазине товаров.
Имеет атрибуты:
  • id - идентификатор категории;
  • parentId - идентификатор родительской категории (если есть).
offers Содержит элементы offer
offer Содержит информацию по товару. Имеет атрибут id - артикул товара.
name Название товара
categoryId Идентификатор категории товара
vendor Бренд товара
vendorCode Артикул товара
description Описание товара
picture Изображение товара
price Цена товара
currencyId Валюта цены товара (доступны RUR, EUR, USD)
param Значение характеристики товара.
Имеет атрибуты:
  • name - название характеристики;
  • unit - единица измерения характеристики (если есть).

Выгрузка Бренда

Описание запроса

Данный запрос производится, если задан параметр запроса brand.

GET https://api.breez.ru/v1/yml/?brand=1

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

В ответ на данный запрос возвращаются все доступные Категории, а также все Продукты соответствующего Бренда.

Ошибки

В случае, если бренда с указанным идентификатором не существует, выгрузка возвращается с пустым объектом <offers>.