Проект

Общее

Профиль

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

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

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

Артем, 01.12.2017 15:10

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
    1
    Артем
    
|=.*apiKey*|=.+|API-ключ|





    16
    
    
    
|=.*apiVersion*|=.+|Версия API|





    17
    
    
    
|=.*clientId*|=.+|Ваш ID клиента|





    18
    
    
    
|=.*domain*|=.+|Домен, для которого сгенерирован API-ключ|





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





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





    21
    
    
    





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





    23
    
    
    





    24
    
    
    
---





    25
    
    
    





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





    27
    
    
    





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





    29
    
    
    





    30
    
    
    
---





    31
    
    
    





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





    33
    
    
    





    34
    
    
    





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





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





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





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





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





    40
    
    
    





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





    42
    
    
    





    43
    
    
    
---





    44
    
    
    





    45
    
    
    
<pre><code class="ruby">





    46
    
    
    
"vins": [





    47
    
    
    
   {





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





    49
    
    
    
      "description": {





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





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





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





    53
    
    
    
         





    54
    
    
    
         ...





    55
    
    
    
         





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





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





    58
    
    
    
      },





    59
    
    
    
      "options": {





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





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





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





    63
    
    
    





    64
    
    
    
         ...





    65
    
    
    





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





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





    68
    
    
    
      },





    69
    
    
    
      "urlParams": {





    70
    
    
    
         "function": "getGroups",





    71
    
    
    
         "vin": "WAUZZZ4BZYN038921",





    72
    
    
    
         "market": "MEX",





    73
    
    
    
         "model": "A6Q",





    74
    
    
    
         "modelcode": "262",





    75
    
    
    
         "year": "2000"





    76
    
    
    
      }





    77
    
    
    
   },





    78
    
    
    
   {





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





    80
    
    
    
      "description": {





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





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





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





    84
    
    
    





    85
    
    
    
         ...





    86
    
    
    





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





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





    89
    
    
    
      },





    90
    
    
    
      "options": {





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





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





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





    94
    
    
    





    95
    
    
    
         ...





    96
    
    
    





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





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





    99
    
    
    
      },





    100
    
    
    
      "urlParams": {





    101
    
    
    
         "function": "getGroups",





    102
    
    
    
         "vin": "WAUZZZ4BZYN038921",





    103
    
    
    
         "market": "RA",





    104
    
    
    
         "model": "A6Q",





    105
    
    
    
         "modelcode": "262",





    106
    
    
    
         "year": "2000"





    107
    
    
    
      }





    108
    
    
    
   }





    109
    
    
    
]





    110
    
    
    
</code></pre>