Проект

Общее

Профиль

История

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

Метод getVin » История » Редакция 3

Редакция 2 (Артем, 01.12.2017 15:10) → Редакция 3/4 (Артем, 21.03.2018 14:32) 

h1. Метод getVin 

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

 --- 

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

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

 --- 

 |=.Параметр|Обязательный|=.Описание| 
 |=.*function*|=.+|getVin| 
 |=.*apiKey*|=.+|API-ключ| 
 |=.*apiVersion*|=.+|Версия API| 
 |=.*clientId*|=.+|Ваш ID клиента| 
 |=.*domain*|=.+|Домен, для которого сгенерирован API-ключ| 
 |=.*brand*|=.-|Бренд |=.*brand*|=.+|Бренд каталога| 
 |=.*vin*|=.+|VIN или FRAME номер| 

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

 --- 

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

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

 --- 

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


 |=.Название|=.Обязательн.|=.Описание| 
 |=.*shortDescription*|=.+|Краткое описание автомобиля| 
 |=.*description*|=.+|Полное описание автомобиля, массив элементов вида *Название характеристики*->*Значение характеристики*| 
 |=.*options*|=.-|Массив описаний опций (комплектации) автомобиля. Элементы вида *Название опции*->*Значение опции*| 
 |=.*urlParams*|=.+|Массив GET-параметров ссылки перехода к следующему этапу поиска. Элементы вида *Название параметра*->*Значение пареметра*| 

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

 --- 

 <pre><code class="ruby"> 
 "vins": [ 
    { 
       "shortDescription": "Audi A6/S6/Avant qu.&nbsp;(A6Q),<BR>Двигатель:&nbsp;AQD", 
       "description": { 
          "Рынок": "Мексика", 
          "Модель": "Audi A6/S6/Avant qu.", 
          "Код модели": "A6Q", 
         
          ... 
         
          "Цвет крыши": "4N", 
          "Код страны": "X0A" 
       }, 
       "options": { 
          "Варианты комплектации&nbsp;(AUS)": "Исполнение стандартное&nbsp;(A8S)", 
          "Спецификации КП&nbsp;(GSP)": "5-speed automatic transmission for        four-wheel drive vehicle&nbsp;(G0Q)", 
          "Тип кузова&nbsp;(KAR)": "Notchback&nbsp;(K8B)", 

          ... 

          "Дополнительный отопитель&nbsp;(ZUH)": "Without auxiliary/parking heater&nbsp;(9M0)", 
          "Система контроля пристёгивания ремней     безопасности&nbsp;(SGK)": "Without seat belt reminder&nbsp;(9P0)" 
       }, 
       "urlParams": { 
          "function": "getGroups", 
          "vin": "WAUZZZ4BZYN038921", 
          "market": "MEX", 
          "model": "A6Q", 
          "modelcode": "262", 
          "year": "2000" 
       } 
    }, 
    { 
       "shortDescription": "Audi A6/S6/Avant quattro&nbsp;(A6Q),<BR>Двигатель:&nbsp;AQD", 
       "description": { 
          "Рынок": "Аргентина", 
          "Модель": "Audi A6/S6/Avant quattro", 
          "Код модели": "A6Q", 

          ... 

          "Цвет крыши": "4N", 
          "Код страны": "X0A" 
       }, 
       "options": { 
          "Варианты комплектации&nbsp;(AUS)": "Исполнение стандартное&nbsp;(A8S)", 
          "Спецификации КП&nbsp;(GSP)": "5-speed automatic transmission for        four-wheel drive vehicle&nbsp;(G0Q)", 
          "Тип кузова&nbsp;(KAR)": "Notchback&nbsp;(K8B)", 

          ... 

          "Дополнительный отопитель&nbsp;(ZUH)": "Without auxiliary/parking heater&nbsp;(9M0)", 
          "Система контроля пристёгивания ремней     безопасности&nbsp;(SGK)": "Without seat belt reminder&nbsp;(9P0)" 
       }, 
       "urlParams": { 
          "function": "getGroups", 
          "vin": "WAUZZZ4BZYN038921", 
          "market": "RA", 
          "model": "A6Q", 
          "modelcode": "262", 
          "year": "2000" 
       } 
    } 
 ] 
 </code></pre>