Документация
Описание доступных методов для работы с сервисами Levam.
Описание доступных методов для работы с сервисами Levam.
Виджет OEM каталогов позволяет самостоятельно подключить ОЕМ каталоги абсолютно к любому сайту. Без долгой и затратной интеграции каталогов через API силами программистов. Пример виджета можно посмотреть в демо.
Преимущества использование виджета:
Просто скопируйте на страницу своего сайта (на которой хотите разместить каталоги) код виджета из кабинета
<script id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>
Если вы хотите отображать на странице только один какой-то каталог - укажите его в параметре start_brand
например:
<script start_brand="bmw" id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>
Для изменения языка каталогов используйте параметр lang например:
<script lang="de" id="levam_oem_catalog" src="https://widgets.levam.net/oem-widget/loader.js" code="xxxxxx" async></script>
Внимание для возможности использовать все языки нужен мультиязычный доступ.
levamVinFind("vincode")
- позволяет инициировать поиск по VIN-номеру. Обычно используется для реализации поиска по VIN-номеру на своем сайте из собственного поля - например из основного поиска по сайту.
При этом поле поиска по VIN-номеру в самом виджете можно отключить в кабинете. Функцию необходимо вызывать на странице,
где размещен виджет.
Вывод информации по каталогам
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
catalogs
- Массив объектов, содержащих информацию о каталогахname |
Название каталога |
code |
Код каталога (устаревший параметр оставлен для совместимости, его значение совпадает с catalog_code) |
catalog_code |
Код каталога |
logo |
Логотип каталога 100*100 |
logo_small |
Маленький логотип каталога 50*50 |
supportframesearch |
Поддерживает ли данный каталог поиск по фрейму |
frameexample |
Пример фрейма для данного каталога |
supportvinsearch |
Поддерживает ли данный каталог поиск по VIN-номеру |
vinexample |
Пример VIN-номера для данного каталога |
universal_classifier |
Для данного каталога доступен универсальный классификатор - методы (TreeFullGet,TreeNodePartsGet), принимает значения yes/no |
type_moto |
Наличие в данном каталоге мотоциклов |
type_auto |
Наличие в данном каталоге легковых автомобилей |
type_transport |
Наличие в данном каталоге грузовых и коммерческих транспортных средств |
error
- Информация об ошибках. Пустое значение - ошибок нетВывод всех семейств и моделей одного производителя.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
catalog
- Объект, содержащий информацию о выбранном каталогеname |
Название каталога |
code |
Код каталога (устаревший параметр оставлен для совместимости, его значение совпадает с catalog_code) |
catalog_code |
Код каталога |
logo |
Логотип каталога 100*100 |
logo_small |
Маленький логотип каталога 50*50 |
supportframesearch |
Поддерживает ли данный каталог поиск по фрейму |
frameexample |
Пример фрейма для данного каталога |
supportvinsearch |
Поддерживает ли данный каталог поиск по VIN-номеру |
vinexample |
Пример VIN-номера для данного каталога |
universal_classifier |
Для данного каталога доступен универсальный классификатор - методы (TreeFullGet,TreeNodePartsGet), принимает значения yes/no |
type_moto |
Наличие в данном каталоге мотоциклов |
type_auto |
Наличие в данном каталоге легковых автомобилей |
type_transport |
Наличие в данном каталоге грузовых и коммерческих транспортных средств |
models
- Массив объектов, содержащий информацию о семействах и моделях
транспортных средств. Каждому семейству может принадлежать одна или более моделей,
перечисленных в массиве. У каждой модели указан код каталога, которому принадлежит данная модель.
error
- Информация об ошибках. Пустое значение - ошибок нетВывод всех семейств и моделей одного производителя.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
catalog
- Объект, содержащий информацию о выбранном каталогеname |
Название каталога |
code |
Код каталога (устаревший параметр оставлен для совместимости, его значение совпадает с catalog_code) |
catalog_code |
Код каталога |
logo |
Логотип каталога 100*100 |
logo_small |
Маленький логотип каталога 50*50 |
supportframesearch |
Поддерживает ли данный каталог поиск по фрейму |
frameexample |
Пример фрейма для данного каталога |
supportvinsearch |
Поддерживает ли данный каталог поиск по VIN-номеру |
vinexample |
Пример VIN-номера для данного каталога |
universal_classifier |
Для данного каталога доступен универсальный классификатор - методы (TreeFullGet,TreeNodePartsGet), принимает значения yes/no |
type_moto |
Наличие в данном каталоге мотоциклов |
type_auto |
Наличие в данном каталоге легковых автомобилей |
type_transport |
Наличие в данном каталоге грузовых и коммерческих транспортных средств |
models
- Массив объектов, содержащий информацию о семействах и моделях
транспортных средств. Каждому семейству может принадлежать одна или более моделей,
перечисленных в массиве. У каждой модели указан код каталога, которому принадлежит данная модель.
error
- Информация об ошибках. Пустое значение - ошибок нетУточнение модификации выбранной модели автомобиля.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
universal_classifier |
Для данного каталога доступен универсальный классификатор - методы (TreeFullGet,TreeNodePartsGet), принимает значения yes/no |
params
- Массив объектов, содержащий информацию о параметрах. Ключом массива
является код параметра. Значением массива является объект, содержащий в себе поля:
name |
Полное название параметра |
values |
Массив параметров, где ключом является полное название значения параметра, а значением - код значения параметра |
error
- Информация об ошибках. Пустое значение - ошибок нетmodel_image
- Изображение выбранной модели транспортного средства. Присутствует
только в том случае, если изображение для данной модели существует.
Выбор модификации транспортного средства в соответствии с выбранными ранее параметрами.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
universal_classifier |
Для данного каталога доступен универсальный классификатор - методы (TreeFullGet,TreeNodePartsGet), принимает значения yes/no |
modifications
- Массив объектов, содержащий информацию о модификации транспортного средства.
Объект содержит в себе названия и значения всех параметров данной модификации и поле
link
- уникльный код модификации транспортного средства
error
- Информация об ошибках. Пустое значение - ошибок нетmodel_image
- Изображение выбранной модели транспортного средства. Присутствует
только в том случае, если изображение для данной модели существует.
Выбор группы запчастей для выбранной модификации транспортного средства.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd.
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
date |
Дата и время создания уникального идентификатора ssd |
groups
- Массив объектов, содержащий информацию о группах запчастейfull_name |
Полное название группы |
group_name |
Код группы запчастей |
image |
Изображение для данной группы |
next
- Указывает на существование вложенных групп запчастей. Если next
равно 1 - то у этой группы есть еще подгруппы
, которые необходимо получить для нахождения деталей. Если значение next
равно 0, значит для выбранной группы не существует подгрупп, а следовательно уже можно
получить список деталей.
model_info
- Информация о выбранной модицикации транспортного средства.error
- Информация об ошибках. Пустое значение - ошибок нет.model_image
- Изображение выбранной модели транспортного средства. Присутствует
только в том случае, если изображение для данной модели есть в базе.
Вывод запчастей, диаграмм и координат.
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd.
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
date |
Дата и время создания уникального идентификатора ssd |
parts
- Массив объектов, содержащий информацию:parts |
Информация о найденных запчастях. Состоит из двух частей: standart и add .
standart представляет из себя массив информации о деталях, имеющуюся
для всех деталей во всех каталогах.
Этот массив состоит из:
add представляет из себя массив дополнительной информации о
детали.
Этот массив состоит из:
|
image |
Чертежи узла, соответствующие выбранной подгруппе |
coord |
Информация о координатах, наобходимых для поиска запчастей на чертежах |
part_name
- Название узла (подгруппы) которому принадлежат указанные в ответе
детали, изображения и координаты.
model_info
- Информация о выбранной модицикации транспортного средства.error
- Информация об ошибках. Пустое значение - ошибок нет.model_image
- Изображение выбранной модели транспортного средства. Присутствует
только в том случае, если изображение для данной модели есть в базе.
Поиск транспортного средства по VIN-номеру
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
models
- Массив объектов, содержащий информацию о модели транспортного средства, соответствующей
запрошенному VIN-номеру. Объект содержит в себе названия и значения всех параметров, принадлежащих
данной модели и поле link
- уникльный код модификации транспортного средства
error
- Информация об ошибках. Пустое значение - ошибок нетПоиск транспортного средства по FRAME номеру
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
client
- Объект, содержащий информацию о выбранном каталоге, семействе транспортного средства,
модели, параметрах, модификации, группе, подгруппе, VIN-номер (в случае когда был осуществлен поиск по
VIN-номеру) и уникальный идентификатор ssd
mark |
Бренд транспортного средства |
catalog_code |
Код каталога |
family |
Семейство транспортного средства |
model |
Модель транспортного средства |
ssd |
Уникальный идентификатор |
param |
Выбранные параметры |
modification |
Выбранная модификация |
group |
Выбранная группа |
subgroup |
Выбранная подгруппа |
vin |
VIN-номер |
frame |
Frame номер |
models
- Массив объектов, содержащий информацию о модели транспортного средства, соответствующей
запрошенному FRAME номеру. Объект содержит в себе названия и значения всех параметров, принадлежащих
данной модели и поле link
- уникльный код модификации транспортного средства
error
- Информация об ошибках. Пустое значение - ошибок нетВывод полного дерева узлов универсального классификатора
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибке. Пустое значение - ошибок нетclient
- Массив объектов, содержащих информацию о текущей сессии:mark - Бренд транспортного средства |
catalog_code - Код каталога |
model - Название модели |
family - Название семейства |
ssd - Уникальный идентификатор |
param - Выбранные параметры |
modification - Выбранная модификация |
group - Выбранная группа |
subgroup - Выбранная подгруппа |
universal_classifier - Для данного каталога доступен универсальный классификатор |
vin - VIN-номер транспортного средства |
frame - Номер рамы |
mod_link
- Код выбранной модификацииtree
- Дерево объектов, содержащих информацию о всех узлах модификации:10000 - id раздела дерева |
name - Название раздела дерева универсального классификатора |
image - Ссылка на изображение раздела дерева универсального классификатора |
branch - Ветка дерева |
nodes - Массив содержащий информацию об узле |
model_image
- Изображение выбранной модели транспортного средства. Присутствует только в том случае, если изображение для данной модели есть в базеmodel_info
- Информация о выбранной модификации транспортного средстваВывод деталей узла выбранного из списка
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
parts
-Массив объектов, содержащий информацию:
parts |
Информация о найденных запчастях. Состоит из двух частей:
|
||||||||||||||
image |
Чертежи узла, соответствующие выбранному узлу | ||||||||||||||
coord |
Информация о координатах, наобходимых для поиска запчастей на чертежах |
part_name
- Название узла (подгруппы) которому принадлежат указанные в ответе
детали, изображения и координаты.
model_info
- Информация о выбранной модицикации транспортного средства.error
- Информация об ошибках. Пустое значение - ошибок нет.model_image
- Изображение выбранной модели транспортного средства. Присутствует
только в том случае, если изображение для данной модели есть в базе.
Вывод каталога, семейства, модели и модификации, в которых встречается деталь.
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибках. Пустое значение - ошибок нет.result
- Массив объектов, содержащий информацию:catalog_code - Код каталога |
|||||||
catalog_name - Название каталога |
|||||||
families - Массив объектов, содержащий информацию о семействах:
|
Вывод модификации с узлами, в которых есть заданная деталь.
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибках. Пустое значение - ошибок нет.result
- Массив объектов, содержащий информацию:catalog_code - Код каталога |
catalog_name - Название каталога |
family_name - Название семейства |
model_name - Название модели |
model_image - Ссылка на изображение модели |
nodes - Массив объектов, содержащий информацию об узлах: |
image - Ссылка на изображение узла |
node_name - Название узла |
group - Код/название группы |
parts - Массив объектов, содержащий информацию о деталях узла: |
pnc - Номер детали на схеме |
Отправляет запрос на проверку заказа
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибках. Пустое значение - ошибок нет.result
- Объект, содержащий информацию о задании:task_id - Идентификатор задачи, для получения результата запроса |
Возвращает результат проверки заказа
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибках. Пустое значение - ошибок нет.result
- Объект, содержащий информацию о задании:ready - true: задача выполнена, false: задача не выполнена |
result - Объект, содержащий в качестве ключей артикулы проверяемых деталей: |
applicable - true/false - Деталь подходит/не подходит к данной модификации |
replacements - Массив строк, содержащий артикулы деталей-замен (имеется более новая деталь) |
Вывод всех запчастей для технического обслуживания
Адрес:
Входные параметры:
Пример:
Ответ:
Описание ответа:
error
- Информация об ошибках. Пустое значение - ошибок нет.result
- Объект, содержащий результат проверки:catalog_code - Код каталога |
catalog_name - Название каталога |
catalog_image - Ссылка на изображение каталога |
family_name - Название семейства |
family_image - Ссылка на изображение семейства |
model_name - Название модели |
model_image - Ссылка на изображение модели |
categories - Массив объектов, содержащий категории деталей: |
category_name - Название категории |
category_code - Код категории |
category_image - Ссылка на изображение категории |
parts - Массив объектов, содержащий информацию о деталях: |
part_code - Артикул детали |
part_name - Название детали |
part_number - Номер детали на схеме |
coords - Массив объектов, содержащий координаты расположения номера детали на схеме: |
top - Вертикальная координата |
left - Горизонтальная координат |
width - Ширина отметки |
height - Высота отметки |
node_name - Название узла |
node_group - Код/название группы |
node_image - Ссылка на изображение узла |
Получение списка возможных брендов по номеру детали
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
parts
- Массив объектов, содержащий информацию о запчастях с искомым номером
search_number |
Номер запчасти очищенный от спец символов и пробелов |
part_number |
Номер запчасти в формате производителя |
brand_name |
Название бренда |
aliases |
Синонимы бренда |
part_name |
Название запчасти |
images |
Массив изображений запчасти |
images_small |
Массив уменьшенных изображений запчасти |
error
- Информация об ошибках. Пустое значение - ошибок нетПолучение списка замен по номеру детали и бренду
Адрес:
Входные параметры:
Выходные параметры:
Пример:
Ответ:
Описание ответа:
requested_part
- Информация о запчасти по которой производился поиск аналогов.
search_number |
Номер запчасти очищенный от спец символов и пробелов |
part_number |
Номер запчасти в формате производителя |
brand_name |
Название бренда |
aliases |
Синонимы бренда |
part_name |
Название запчасти |
images |
Массив изображений запчасти |
images_small |
Массив уменьшенных изображений запчасти |
oem_replacements |
Номера оригинальных замен |
applicability |
Применяемость детали (марки и модели автомобилей где она используется) |
settings |
Параметры запчасти (масса, размер и тп.) |
replacements
- Массив объектов, содержащий информацию о аналогах запрошенной
запчасти
search_number |
Номер запчасти очищенный от спец символов и пробелов |
part_number |
Номер запчасти в формате производителя |
brand_name |
Название бренда |
aliases |
Синонимы бренда |
part_name |
Название запчасти |
images |
Массив изображений запчасти |
images_small |
Массив уменьшенных изображений запчасти |
error
- Информация об ошибках. Пустое значение - ошибок нет