Проверка авто по VIN и гос.номеру через API
Описание метода
С помощью данного метода осуществляется проверка автомобиля по VIN или гос.номеру. В ответ на запрос вы получаете полный отчет транспортного средства в разных форматах (форматы перечислены ниже).
API сайта расположен по адресу: https://lk.carinform.ru/API/
Обращаем внимание, что API принимает только POST-запросы в кодировке UTF8.
Настоятельно рекомендуем для работы с API использовать библиотеку CURL.
Данный метод работает по принципу: создание запроса -> получение номера задачи -> опрос задачи по номеру и получение ответа.
Создание запроса
- API — ключ API *
- TypeAPI — тип запроса ‘full’ *
- vin — VIN код транспортного средства, состоящий из 17 символов. Допустимы только английские символы и цифры!
- number — гос.номер транспортного средства с кодом региона без пробелов и иных специальных символов. Допустимы только русские символы и цифры!
$url = 'https://lk.carinform.ru/API/';
$post_data = array(
'API' => 'ваш-апи-ключ',
'TypeAPI' => 'full',
'vin' => 'XW8ZZZ5NZDG131137 '
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$output = curl_exec($ch);
curl_close($ch);
echo $output;
На выходе Вы получите данные в формате JSON.
При успешном запросе в массиве ответа JSON Вы получите значения:
- ‘status‘ со значением ‘success’
- ‘UUID‘ — номер (идентификатор) заявки
Например: {«status»:»success»,»UUID»:»799bea54-1378-11eb-9f73-00e081ca301d»}
При ошибке в запросе в массиве ответа JSON Вы получите ‘status’ со значением ‘error’, а также код и описания (на русском и английском языках) ошибки.
Например: {«status»:error,»code»=> 8,»message_ru»=>»VIN код некорректный»,»message_en»=>»VIN code is invalid»}
Получение ответа
Параметры для получения ответа по номеру задачи:
- API — ключ API *
- TypeAPI — тип запроса ‘getResult‘ *
- UUID — номер (идентификатор) заявки (выдается при создании заявки) *
- TypeReport — тип желаемого отчета. Допускаются значения ‘json’ (запрос объекта JSON с результатами отчета), ‘html’ (запрос ссылки на скачивание файла в формате HTML) и ‘pdf’ (запрос ссылки на скачивание файла в формате PDF), При отсутствии параметра ‘TypeReport’ отчет будет сформирован в формате PDF.
Пример запроса на языке PHP:
$url = 'https://lk.carinform.ru/API/';
$post_data = array(
'API' => 'ваш-апи-ключ',
'TypeAPI' => 'getResult',
'UUID' => '7992bea54-1378-11eb-9f73-00e081c3a301d',
'TypeReport'=> 'json'
);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_data);
$output = curl_exec($ch);
curl_close($ch);
echo $output;
На выходе Вы получите данные в формате JSON.
При успешном запросе в массиве ответа JSON Вы получите значения:
- ‘status‘ со значением ‘complete’,
- ‘result‘ — запрошенные данные (если отчет запрашивался в формате JSON) или ссылка на файл (если отчет запрашивался в формате PDF или HTML)
Например, при запросе в формате PDF :{«status»:»complete»,»result»:»http:\/\/lk.carinform.ru\/\/download\/reports\/18\/799bea54-1378-11eb-9f73-00e081ca301d.pdf»}
В формате JSON {«status»:»complete»,»result»:{«autofillplus»:{…}, «photos»:[], «ads»:[{…},{…}], «gibddrestricted»:[], «gibddwanted»:[], «zalognotary»:[], «zalogfedresurs»:[], «taxi»:[], «gibdddtp»:[], «gibddhistory»:{«history»:[{…},{…},{…},{…},{…},{…},{…}],»vehicle»:{…}}, «probeg»:{…}, «eaist»:[{…}], «fts»:[], «osago»:[{…}], «osagoinfo»:{…}, «fines»:[], «otzivcamp»:[]}}
Отчет состоит из набора ответов различных типов запросов. Список алиасов ответов Вы можете увидедеть на странице «Настройки»->»Виды запросов».
При ошибке в запросе в массиве ответа JSON Вы получите ‘status’ со значением ‘error’, а также код и описания (на русском и английском языках) ошибки.
Например, {«status»:error»,»code»=> 14,»message_ru»=>»Такого запроса не существует»,»message_en»=>»Requested order not found»}