Проект

Общее

Профиль

Редактировать История

Wiki » Сервис оригинальных каталогов » Доступ через API »

Метод getVin » История » Версия 4

Артем, 11.03.2019 13:44

1 1 Артем 
h1. Метод getVin
2 





3



h2. Описание метода





4








5



---





6








7



p(. Осуществляет расшифровку VIN или FRAME номера автомобиля.





8








9



h2. Параметры вызова





10








11



---





12








13



|=.Параметр|Обязательный|=.Описание|





14
2
Артем

|=.*function*|=.+|getVin|





15
3
Артем

|=.*brand*|=.-|Бренд каталога|





16
1
Артем

|=.*vin*|=.+|VIN или FRAME номер|





17








18



h2. Пример вызова





19








20



---





21








22



http://api.ilcats.ru/?clientId=1234567890&domain=www.ilcats.ru&apiKey=abxxxxxxxxxxxxxxxxxxxx98&apiVersion=2.0&brand=audi&function=getVin&vin=WAUZZZ4BZYN038921





23








24



h2. Возвращаемые данные





25








26



---





27








28



p(. Метод возвращает массив значений *vins*, содержащий расшифровки найденных расшифровок VIN/FRAME номера. Каждый элемент массива содержит в себе 4 элемента:





29








30








31



|=.Название|=.Обязательн.|=.Описание|





32



|=.*shortDescription*|=.+|Краткое описание автомобиля|





33



|=.*description*|=.+|Полное описание автомобиля, массив элементов вида *Название характеристики*->*Значение характеристики*|





34



|=.*options*|=.-|Массив описаний опций (комплектации) автомобиля. Элементы вида *Название опции*->*Значение опции*|





35



|=.*urlParams*|=.+|Массив GET-параметров ссылки перехода к следующему этапу поиска. Элементы вида *Название параметра*->*Значение пареметра*|





36








37



h2. Пример возвращаемых данных





38








39



---





40








41



<pre><code class="ruby">





42



"vins": [





43



   {





44



      "shortDescription": "Audi A6/S6/Avant qu.&nbsp;(A6Q),<BR>Двигатель:&nbsp;AQD",





45



      "description": {





46



         "Рынок": "Мексика",





47



         "Модель": "Audi A6/S6/Avant qu.",





48



         "Код модели": "A6Q",





49



         





50



         ...





51



         





52



         "Цвет крыши": "4N",





53



         "Код страны": "X0A"





54



      },





55



      "options": {





56



         "Варианты комплектации&nbsp;(AUS)": "Исполнение стандартное&nbsp;(A8S)",





57



         "Спецификации КП&nbsp;(GSP)": "5-speed automatic transmission for      four-wheel drive vehicle&nbsp;(G0Q)",





58



         "Тип кузова&nbsp;(KAR)": "Notchback&nbsp;(K8B)",





59








60



         ...





61








62



         "Дополнительный отопитель&nbsp;(ZUH)": "Without auxiliary/parking heater&nbsp;(9M0)",





63



         "Система контроля пристёгивания ремней   безопасности&nbsp;(SGK)": "Without seat belt reminder&nbsp;(9P0)"





64



      },





65



      "urlParams": {





66



         "function": "getGroups",





67



         "vin": "WAUZZZ4BZYN038921",





68



         "market": "MEX",





69



         "model": "A6Q",





70



         "modelcode": "262",





71



         "year": "2000"





72



      }





73



   },





74



   {





75



      "shortDescription": "Audi A6/S6/Avant quattro&nbsp;(A6Q),<BR>Двигатель:&nbsp;AQD",





76



      "description": {





77



         "Рынок": "Аргентина",





78



         "Модель": "Audi A6/S6/Avant quattro",





79



         "Код модели": "A6Q",





80








81



         ...





82








83



         "Цвет крыши": "4N",





84



         "Код страны": "X0A"





85



      },





86



      "options": {





87



         "Варианты комплектации&nbsp;(AUS)": "Исполнение стандартное&nbsp;(A8S)",





88



         "Спецификации КП&nbsp;(GSP)": "5-speed automatic transmission for      four-wheel drive vehicle&nbsp;(G0Q)",





89



         "Тип кузова&nbsp;(KAR)": "Notchback&nbsp;(K8B)",





90








91



         ...





92








93



         "Дополнительный отопитель&nbsp;(ZUH)": "Without auxiliary/parking heater&nbsp;(9M0)",





94



         "Система контроля пристёгивания ремней   безопасности&nbsp;(SGK)": "Without seat belt reminder&nbsp;(9P0)"





95



      },





96



      "urlParams": {





97



         "function": "getGroups",





98



         "vin": "WAUZZZ4BZYN038921",





99



         "market": "RA",





100



         "model": "A6Q",





101



         "modelcode": "262",





102



         "year": "2000"





103



      }





104



   }





105



]





106



</code></pre>