- Главная
- >
- API - доступ к базе данных FLIM.RU
API - доступ к базе данных FLIM.RU
Форматы данных
Два формата выдачи информации
- В формате XML
- В формате JSON
Методы
1. Запрос каталога продукции по параметрам
1.1. Запрос каталога продукции
URL запросов = https://www.flim.ru/api/Items/{номенклатура}
Параметры запроса:
- {номенклатура}* - номенклатура по которой запрашивается каталог продукции (описание в пункте 4)
- GET параметры запроса:
marka* - марка авто
model - модель авто
pg - поколение, год выпуска в формае P (GGGG - GGGG), где Р - поколение, GGGG - года (для получения данных смотри пункт 3.2)
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/Items/consul?marka=SSANG_YONG
https://www.flim.ru/api/Items/bastion?marka=lada&model=GRANTA&format=json
https://www.flim.ru/api/Items/consul?marka=infiniti&model=fx 30d&pg=I (2012 - 2013)&format=json
Структура ответа данных
При удачном ответе возвращается структура - Каталог.
Документ имеет структуру:
- Каталог - корневой узел** документа, определяющий структуру данных документа.
- НоменклатурнаяГруппа - узел определяющий название продукции
- ГруппаПрименяемости - узел содержащий данные о применяемости:
- ID - для запроса,
- Наименование,
- Марка,
- Модель,
- Поколение,
- ГодВыпускаС,
- ГодВыпускаПо,
- ТипКПП,
- Расположение,
- ПоложениеБлокировки,
- ФотоСалон***,
- ФотоКузов***
- Номенклатура - узел содержит набор данных о замке:
- ID - для запроса,
- Наименование,
- НаименованиеПолное,
- Артикул,
- НоменклатурнаяГруппа,
- Состояние,
- ЦенноваяГруппа,
- СпециальноеПредложениеПоЦене,
- Вес,
- Применяемость,
- IDТехкомплект - для запроса
- НаборДополнительныхОпций:
- ID - для запроса,
- Наименование,
- НаименованиеПолное,
- Артикул,
- НоменклатурнаяГруппа,
- Состояние,
- ЦенноваяГруппа,
- СпециальноеПредложениеПоЦене,
- Вес,
- Применяемость,
- IDТехкомплект - для запроса
- НаборДополнительныхОпцийПримечание,
- НаборДополнительныхОпцийОбозначение,
- НаборДополнительныхОпцийГруппаПрименяемости,
- Цена - с установкой,
- Цена1 - без установки
** под термином "узел" понимается обобщенное понятие элемента (xml) и ключа (json)
*** конструктор адресов картинок описан ниже
Коллекции данные связаны одним индексом.
При ошибке, в случае удачного ответа
Структура ответа содержит параметры GET запроса.
Пример запроса:
https://www.flim.ru/api/Items/XXXX?marka=lexus
1.2. Запрос каталога универсальной продукции
URL запросов = https://www.flim.ru/api/ItemsUP/{marka}
Параметры запроса:
- {marka}* - марка по каторой запрашивается каталог
- GET параметры запроса:
model - модель авто
pg - поколение, год выпуска в формае P (GGGG - GGGG), где Р - поколение, GGGG - года (для получения данных смотри пункт 3.2)
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/ItemsUP/bmw
https://www.flim.ru/api/ItemsUP/lada?model=granta&format=json
https://www.flim.ru/api/ItemsUP/infiniti?model=fx 30d&pg=I (2012 - 2013)&format=json
Структура ответа данных
При удачном ответе возвращается структура - КаталогУниверсальнойПродукции.
Документ имеет структуру:
- КаталогУниверсальнойПродукции - корневой узел** документа, определяющий структуру данных документа.
- НоменклатурнаяГруппа - узел определяющий название продукции,
- Марка,
- Модель,
- Поколение,
- Номенклатура - узел содержит набор данных о замке:
- ID - для запроса,
- Наименование,
- НаименованиеПолное,
- Артикул,
- НоменклатурнаяГруппа,
- Состояние,
- ЦенноваяГруппа,
- СпециальноеПредложениеПоЦене,
- Вес,
- Применяемость,
- IDТехкомплект - для запроса
- Цена - с установкой,
- Цена1 - без установки
** под термином "узел" понимается обобщенное понятие элемента (xml) и ключа (json)
Коллекции данные связаны одним индексом.
При ошибке, в случае удачного ответа
Структура ответа содержит параметры GET запроса.
Пример запроса:
https://www.flim.ru/api/ItemsUP/XXXX?model=lexus
2. Запрос продукции по параметрам
URL запросов = https://www.flim.ru/api/Item/{idItem}
Параметры запроса:
- {idItem}* - id продукции, получают из каталога: node:Номенклатура - ID
- GET параметры запроса:
idGoup - id группы применяемости, получают из каталога: node:ГруппаПрименяемости - ID
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/Item/63a40a90-0675-11e4-a080-3085a9a96999?format=xml
https://www.flim.ru/api/Item/63a40a90-0675-11e4-a080-3085a9a96999?idGoup=ab3689b8-ed3c-11e3-ace6-3085a9a96999&format=json
Структура ответа данных
При удачном ответе возвращается структура - КарточкаПродукцииФЛИМ.
Документ имеет структуру:
- КарточкаПродукцииФЛИМ - корневой узел** документа, определяющий структуру данных документа.
- Продукция - узел содержащий сведения о замке:
- ID - для запроса,
- Наименование,
- НаименованиеПолное,
- Артикул,
- НоменклатурнаяГруппа,
- Состояние,
- ЦенноваяГруппа,
- СпециальноеПредложениеПоЦене,
- Вес,
- Применяемость,
- IDТехкомплект - для запроса
- ГруппыПрименяемости - узел содержащий данные о применяемости:
- ID - для запроса,
- Наименование,
- Марка,
- Модель,
- Поколение,
- ГодВыпускаС,
- ГодВыпускаПо,
- ТипКПП,
- Расположение,
- ПоложениеБлокировки,
- Фотоинструкции***:
- Наименование,
- Файл,
- Архив (false - действующая, true - не действующая. в архиве) /ul>
- ФотоСалон***,
- ФотоКузов***,
- Цена - с установкой,
- Цена1 - без установки,
- Составная,
- УниверсальнаяПрименяемостьНаАвтомобили
- Продукция - узел содержащий сведения о замке:
** под термином "узел" понимается обобщенное понятие элемента (xml) и ключа (json)
*** конструктор адресов картинок и файлов описан ниже
- GET параметры запроса:
idGoup - id группы применяемости, получают из каталога: node:ГруппаПрименяемости - ID
format - формат выходных данных (по умолчанию выдается в формате XML)
Коллекции данные связаны одним индексом.
При ошибке, в случае удачного ответа
Структура ответа содержит параметры GET запроса.
Пример запроса:
https://www.flim.ru/api/Item/XXXX
2.1. Запрос цены составной продукции Гарант BLOK PRO
URL запросов = https://www.flim.ru/api/CostPro/{idItem}_{idGoup}
Параметры запроса:
- {idItem}* - id продукции, получают из каталога: node:Номенклатура - ID
- {idGoup}* - id группы применяемости, получают из каталога: node:ГруппаПрименяемости - ID
- GET параметры запроса:
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/CostPro/2833ac44-dbfa-11e8-b16b-0cc47a7e3242_0ac030b2-fbb9-11df-9fc3-00248c3ccfea
https://www.flim.ru/api/CostPro/2833ac44-dbfa-11e8-b16b-0cc47a7e3242_0ac030b2-fbb9-11df-9fc3-00248c3ccfea?format=json
Структура ответа данных
При удачном ответе возвращается структура - ArrayOfПараметр.
Документ имеет структуру:
- Параметр:
- ВидЦены,
- Значение,
- IdКомплектующих:
- string - ID идентификаторы деталей входящих в состав (для запросов КарточкаПродукцииФЛИМ)
При ошибке, в случае удачного ответа
Структура ответа содержит параметры запроса.
Пример запроса (передаем по ошибке Гарант Блок Люкс 733.E/f - AUDI A1):
https://www.flim.ru/api/CostPro/e7ed87e6-e52b-11e2-8c6b-f46d04653457_0ac030b2-fbb9-11df-9fc3-00248c3ccfea
3. Запрос сведений по параметрам
3.1. Запрос марок и моделей
URL запросов = https://www.flim.ru/api/Data/{номенклатура}
Параметры запроса:
- {номенклатура}* - номенклатура по которой запрашиваются марки и модели применяемости
- GET параметры запроса:
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/Data/consul?format=xml
https://www.flim.ru/api/Data/block?format=json
Структура ответа данных
При удачном ответе возвращается структура - Marks.
Документ имеет структуру:
- Marks:
- МаркаМодели:
- Марка - можно использовать при запросе структуры Каталог
- Модель - можно использовать при запросе структуры Каталог
- МассивМарок:
- string - марка, можно использовать при запросе структуры Каталог
- МаркаМодели:
При ошибке, в случае удачного ответа
Структура ответа содержит параметры GET запроса.
Пример запроса:
https://www.flim.ru/api/Data/XXXX
3.2. Запрос поколения и годов выпуска
URL запросов = https://www.flim.ru/api/Data/{номенклатура}
Параметры запроса:
- {номенклатура} - номенклатура по которой запрашиваются марки и модели применяемости
- GET параметры запроса:
Params.Марка* - марка авто
Params.Модель* - модель авто
format - формат выходных данных (по умолчанию выдается в формате XML)
* обязательные параметры запроса
Пример запроса:
https://www.flim.ru/api/Data/consul?Params.Марка=LADA&Params.Модель=GRANTA&format=xml
https://www.flim.ru/api/Data?Params.Марка=LADA&Params.Модель=GRANTA&format=xml
Структура ответа данных
При удачном ответе возвращается структура - MarksYears.
Документ имеет структуру:
- MarksYears:
- НоменклатурныеГруппы:
- Номенклатура - намсенование номенклатур, по которым выдается отмет
- ...
- Марка
- Модель
- ГодаВыпуска:
- Год:
- ГодВыпуска
- Поколение
- ГодВыпускаС
- ГодВыпускаПо
- ...
- Год:
- НоменклатурныеГруппы:
При ошибке, в случае удачного ответа
Структура ответа содержит параметры GET запроса.
Пример запроса:
https://www.flim.ru/api/Data?Params.Марка=LADAs&Params.Модель=GRANTAs
4. Дополнительные сведения
Обозначения номенклатуры:
- consul - Блокиратор коробки передач
- bastion - Блокиратор рулевого вала с выключателем зажигания
- block - Блокиратор рулевого вала
- ip_ign - блокиратор электрических цепей, иммобилайзер
- panzer - Защита замка зажигания
- ip_gr - Электромеханический блокиратор КПП
- fort - Бесштыревой блокиратор рулевого вала
- 2lock - Блокиратор КПП с замком капота
- pro - Усиленный блокиратор рулевого вала.
Продукция Гарант Блок PRO не продаётся готовыми замками. Производится продажа только комплекта: Стопор + Муфта. Цена комплекта равна сумме цен частей комплекта.
Получение цен производится по пункту 2.1.
Формат запроса файлов
Картинки:
Выдаваемые картинки имеют один формат - jpg
Запрашиваемый файл имеет идентификатор, к примеру - I00043288, тогда для получения файла необходимо составить путь запроса - https://www.flim.ru/image/I00058261.jpg
Если необходимо задать конкретную ширину, это можно сделать указав ее значение в адресе запроса - https://www.flim.ru/image/250/I00058261.jpg
Файлы документации:
Выдаваемые файлы имеют один формат - pdf
Запрашиваемый файл имеет идентификатор (указывается в узле - Файл), к примеру - 000397575, тогда для получения файла необходимо составить путь запроса - https://www.flim.ru/file/000397575.pdf
Если необходимо задать название файла, это можно сделать указав значение Наименование (из одноименного узла), к примеру - Инструкция по установке Гарант Блок Люкс 11-075.E/f для BMW X5, тогда для получения файла необходимо составить путь запроса - https://www.flim.ru/file/000073987/Инструкция по установке Гарант Блок Люкс 11-075.E/f для BMW X5.pdf
Пример подгрузки данных JSON jQuery
Пример скрипта по ссылке: Посмотреть пример! (в новом окне)
Пример подгрузки данных XML jQuery
Зная формирование запросов поиска по сайту www.autocomp.ru, организовать поиск замков из базы Флим. Запрос на поиск по сайту выглядит так: https://www.autocomp.ru/search?q={наименование}. Ниже представлена реализация.
Пример скрипта по ссылке: Посмотреть пример! (в новом окне)
5. Поддержка
По всем вопросам связанным с интеграцией можно обращаться на I.J.Kurbatov@flim.ru (Курбатов Игорь Юрьевич)
Внимание!
Если Вы используете шлюз, то сообщите по указанной выше почте адреса доменов и email администраторов для информирования о конструктивном изменении работы шлюза.