Документация по работе с API Bidcars (История автомобилей из США с аукционов Copart и IAAI)
Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/bidcars.php с персональным ключом API и параметрами.
Пример отправки GET запроса на PHP:
function get_rez($url) {
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch,CURLOPT_TIMEOUT,120); // Таймаут необходим, поскольку 30 секунд может не хватить и вы не получите ответ
$res = curl_exec($ch);
curl_close($ch);
return $res;
}
$data = [
'type' => 'Тип запроса (type)',
...
Необходимы для запроса параметры
...
'token' => 'Токен',
];
// Структурированная ссылка для GET запроса
$url = 'https://api-cloud.ru/api/bidcars.php?' . http_build_query($data);
$data = get_rez($url); // Результат ответа (JSON)
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа
| type (тип) | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| vin | Поиск ТС на аукционах по vin номеру
• Марка
• Модель
• Год выпуска
• Двигатель
• Тип топлива
• Цилиндры
• Коробка передач
• Количество мест
• Привод
• Цвет кузова
• Пробег
• Кузов
• Аукцион
• Номер лота
• Дата продажи
• Основное повреждение
• Вторичное повреждение
• Оценочная стоимость
• Цена ремонта
• Документы
• Оценочная стоимость
• Расположение аукциона
• Комплектация
• Фотографии (ссылки на скачивания, действуют 15 минут)
|
Обязательные vin - VIN номер Разрешено: кирилица, цифры token - персональный ключ API |
Примеры запросов
Поиск ТС на аукционах по vin номеру
Пример запроса "info" HTTP GET на URL нашего API
Пример успешного запроса по типу vin формате JSON
https://api-cloud.ru/api/bidcars.php?type=vin&vin=19VDE1F30EE014790&&token=53ba1b7a55********a97eff3a5220792
{
"status":200,
"found":true,
"rez":{
"marka":{
"title":"Марка",
"value":"AUDI"
},
"model":{
"title":"Модель",
"value":"Q7"
},
"year":{
"title":"Год выпуска",
"value":"2019"
},
"vin":{
"title":"VIN",
"value":"19VDE1F30EE014790"
},
"engine":{
"title":"Двигатель",
"value":"2.0L 4"
},
"fuel":{
"title":"Тип топлива",
"value":"GAS"
},
"cylinders":{
"title":"Цилиндры",
"value":"4"
},
"transmission":{
"title":"Коробка передач",
"value":"AUTOMATIC"
},
"Number_seats":{
"title":"Количество мест",
"value":null
},
"drive":{
"title":"Привод",
"value":"Front-wheel Drive"
},
"color":{
"title":"Цвет кузова",
"value":"BLACK"
},
"mileage":{
"title":"Пробег",
"value":"148913 km (A)"
},
"body":{
"title":"Кузов",
"value":""
},
"auction":{
"title":"Аукцион",
"value":"copart"
},
"lot":{
"title":"Номер лота",
"value":"48300922"
},
"date":{
"title":"Дата продажи",
"value":"27 окт. 2022 г."
},
"damage":{
"title":"Основное повреждение",
"value":"FRONT END"
},
"secondary_damage":{
"title":"Вторичное повреждение",
"value":""
},
"description":{
"title":"Описание",
"value":""
},
"keys":{
"title":"Ключи",
"value":"YES"
},
"price":{
"title":"Оценочная стоимость $",
"value":"15053"
},
"repair_price":{
"title":"Цена ремонта $",
"value":null
},
"docs":{
"title":"Документы",
"value":"TN SC"
},
"location":{
"title":"Расположение аукциона",
"value":null
},
"equipment":{
"title":"Комплектация",
"value":"ILX 20"
},
// Массив с ссылками для скачивания (ссылки действуют 15 минут)
"imgs": [
"https://api-cloud.ru/api/carPhoto/fea82281f707fc4cf42c.jpg",
"https://api-cloud.ru/api/carPhoto/dc7507a6d29a72b472fe.jpg",
"https://api-cloud.ru/api/carPhoto/cd63e45f365f623cd516.jpg",
"https://api-cloud.ru/api/carPhoto/5be938bb29a09fd979f7.jpg",
"https://api-cloud.ru/api/carPhoto/ea49c8358d94d39cc5bb.jpg",
"https://api-cloud.ru/api/carPhoto/9423b05702ef385f1561.jpg",
"https://api-cloud.ru/api/carPhoto/fa12e36ef1900d844173.jpg",
"https://api-cloud.ru/api/carPhoto/55cb1caf285ff9f8d9bd.jpg",
"https://api-cloud.ru/api/carPhoto/4c2d1bcd8be7b55ed614.jpg",
"https://api-cloud.ru/api/carPhoto/3adfb3a09f782f317d70.jpg",
"https://api-cloud.ru/api/carPhoto/794639efaf04c968d69d.jpg",
"https://api-cloud.ru/api/carPhoto/b52dd8ed4b0eed88ef38.jpg",
"https://api-cloud.ru/api/carPhoto/4be5ced0651fb820c6cc.jpg"
]
},
"inquiry":{
"price":0.5,
"balance":2174.48,
"speed":2,
"attempts":1
}
}
История изменений API Bidcars
| дата | что изменилось |
|---|---|
| 20.10.2024 | Метод vin: Изменен алгоритм вывода изображений в массиве imgs. Теперь вместо прямых ссылок в выводе ссылки на api-cloud. Ссылки на изображения действуют 15 минут. |
| 18.04.2023 | Скорректирована документация и исправлены опечатки. |
| 17.02.2023 | Добавлены новые ключи в вывод результата по методу запроса vin: |
| 23.10.2022 | В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. |
Возможные коды ошибок
| код (error) | Описание ошибки (message) |
|---|---|
| 888 | ИМЯ передаваемой переменной: forbidden symbols present В переменной ИМЯ присутствуют запрещенные символы |
| 766 | MISSING_MANDATORY_PARAMETER Отсутствуют обязательные параметры |
| 602 | TOKEN_NO_ACCESS Нет доступа к запрашиваему методу запроса |
| 504 | TOKEN_LOCKED_IN_THE_SYSTEM Переданный токен заблокирован службой качества / автоматической системой |
| 503 | TOKEN_NOT_REGISTERED_IN_THE_SYSTEM Переданный токен не зарегистрирован в системе |
| 502 | MISSING_REQUIRED_TOKEN_PARAMETER Отсутствует параметр token |
| 501 | MISSING_REQUIRED_VIN_PARAMETER Отсутствует параметр vin или указан неверно |
| 500 | MISSING_REQUIRED_TYPE_PARAMETER Отсутствует параметр type |
| 499 | WRONG_TOKEN_KEY Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа. |
| 498 | TOKEN_NO_MONEY Для выполнения запроса недостаточно средств, пополните баланс. |
| 460 | NO_REQUIRED_PARAMETERS Отсутствуют обязательные параметры |
| 456 | MAX_LIMIT Превышено количество одновременных соединений (потоки) |
| 404 | TIME_MAX_CONNECT Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже. |
| 123 | IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК |
| 111 | PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно. |
| 015 | DATE_ERROR Ошибка значения переданной даты |
| 005 | TEST_TIME_OFF Закончился период тестирования |
| 003 | TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой |
| 002 | TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности. |
| 001 | API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже. |
{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}
Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}