Руководство разработчика
Ресурсы API

Поиск производителя по названию

Описание

vendor/match

Возвращает название производителя, наиболее подходящего под заданное во входных данных название.

URL ресурса:

https://api.content.market.yandex.ru/v1/vendor/match.[format]

Входные данные

Параметр

Тип

Значение

Обязательные

name

Строка

Название производителя, данные которого необходимо найти.

Необязательные

fields

Enum

Параметры модели, которые необходимо показать в выходных данных.

Примечание. Для некоторых ресурсов не все значения влияют на выходные данные.

Возможные значения:

  • ALL — все параметры;

  • CATEGORY — идентификатор и название категории, к которой относится модель;

  • DISCOUNTS — информация о скидках на модель;

    Ограничение. Значение DISCOUNTS работает только совместно со значением PRICE: fields=DISCOUNTS,PRICE.
  • FACTS — список достоинств и недостатков модели;

  • FILTERS — основные фильтры;

  • LINK — URL-адрес карточки модели, страницы производителя или категории на Яндекс.Маркете. Выводится в выходном параметре link. Значение link зависит от того, в какой параметр он вложен (model, vendor или category);

  • MEDIA — количество обзоров и отзывов на модель;

  • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель;

  • OFFERS — количество товарных предложений, соотнесенных с моделью, в указанном регионе;

  • PHOTO — изображение модели, используемое как основное изображение на карточке модели
    [no-highlight[

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

    ]no-highlight]
    ;
  • PRICE — описание цен на модель;

  • RATING — количество оценок и рейтинг модели (величина, которая показывает сводную пользовательскую оценку потребительских свойств товара);

  • VENDOR — информация о производителе: идентификатор, изображение логотипа, адрес сайта и название.

В значении параметра можно комбинировать параметры, разделяя их запятой. Например, fields=CATEGORY,FACTS,MEDIA.

Значение по умолчанию: CATEGORY,PHOTO.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

<result
[no-highlight[

Значение

Описание найденного производителя и список его параметров.

Параметр выводится только для формата XML.

]no-highlight]
time
[no-highlight[

Значение

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

]no-highlight]
="{время_ответа_API}"> <vendor
[no-highlight[

Значение

Описание производителя.

Для формата XML в данном параметре указывается наименование производителя, для формата JSON — во вложенном параметре name.

]no-highlight]
id
[no-highlight[

Значение

Идентификатор производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
="{идентификатор_производителя}" link
[no-highlight[

Значение

URL страницы производителя на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
="{URL_производителя_на_Маркете}" picture
[no-highlight[

Значение

URL логотипа производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
="{URL_логотипа}" site
[no-highlight[

Значение

URL официального сайта производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
="{URL_сайта}">{название_производителя}</vendor> </result>
{
  "time
[no-highlight[

Значение

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

]no-highlight]
": {время_ответа_API}, "vendor
[no-highlight[

Значение

Описание производителя.

Для формата XML в данном параметре указывается наименование производителя, для формата JSON — во вложенном параметре name.

]no-highlight]
": { "id
[no-highlight[

Значение

Идентификатор производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
": {идентификатор_производителя}, "link
[no-highlight[

Значение

URL страницы производителя на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
": "{URL_производителя_на_Маркете}", "picture
[no-highlight[

Значение

URL логотипа производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
": "{URL_логотипа}", "site
[no-highlight[

Значение

URL официального сайта производителя.

Для формата XML является атрибутом параметра vendor.

]no-highlight]
": "{сайт_производителя}", "name
[no-highlight[

Значение

Название производителя.

Параметр выводится только для формата JSON.

]no-highlight]
": "{назание_производителя}" } }

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

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

result

Описание найденного производителя и список его параметров.

Параметр выводится только для формата XML.

Параметры, вложенные в result

time time Число

Время ответа API в миллисекундах.

Для формата XML является атрибутом параметра result.

vendor vendor

Описание производителя.

Для формата XML в данном параметре указывается наименование производителя, для формата JSON — во вложенном параметре name.

Параметры, вложенные в vendor

id id Long

Идентификатор производителя.

Для формата XML является атрибутом параметра vendor.

link link String

URL страницы производителя на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

Для формата XML является атрибутом параметра vendor.

picture picture String

URL логотипа производителя.

Для формата XML является атрибутом параметра vendor.

site site String

URL официального сайта производителя.

Для формата XML является атрибутом параметра vendor.

name Строка

Название производителя.

Параметр выводится только для формата JSON.

Описания ошибок

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.content.market.yandex.ru/v1/vendor/match.xml?name=Nike&fields=ALL'

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

HTTP/1.1 200 OK
Date: Fri, 20 May 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...

<result time="1438875218740">
  <vendor id="6211303" link="https://market.yandex.ru/brands.xml?br..." picture="http://example.ru/picture.jpg" site="www.nike.com">Nike</vendor>
</result>

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

curl -i -H 'Content-Type: application/json' -X GET 'https://api.content.market.yandex.ru/v1/vendor/match.json?name=Nike&fields=ALL'

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

HTTP/1.1 200 OK
Date: Fri, 20 May 2016 12:08:12 GMT
Content-Type: application/json;charset=utf-8
...

{
  "time": 1438876265603,
  "vendor":
  {
    "id": 6211303,
    "link": "https://market.yandex.ru/brands.xml?br...",
    "picture": "http://example.ru/picture.jpg",
    "site": "www.nike.com",
    "name": "Nike"
  }
}
vendor/{match} Поиск производителя по названию