Документация по работе с API Каталог фотографий авто
Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/autocatalog.php с персональным ключом API и параметрами.
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON
Базовая цена запроса: 0.50 руб.
История изменений/обновлений
| type (тип) | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| modelList new | Вывод списка доступных моделей |
Обязательные token - персональный ключ API Средства за запрос не списываются.
|
| chekmodel | Вывод моделей с их ID по марке (шаг 1) |
Обязательные marka - Марка автомобиля Получить список марок можно через type->modelList Разрешено: кириллица, латиница, цифры, знак "-" token - персональный ключ API |
| carPhoto | Вывод фотографий по ID модели (шаг 2) |
Обязательные modelid - ID модели (из ответа на тип запроса chekmodel) Разрешено: цифры token - персональный ключ API Обратите внимание: Ссылки на фотографии доступны в течение 10 минут, после удаляются. Поэтому рекомендуем скачивать на свой ресурс. |
Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}
Примеры запросов
Вывод списка доступных моделей
Пример запроса "Вывод существующих моделей автомобиля" HTTP GET на URL нашего API
https://api-cloud.ru/api/autocatalog.php?type=modelList&token=53ba1b7a55abbB014aa97eff3a522079
Есть данные о моделях
{
"status":200,
"count":96,
"rez":[
"Acura",
"Alfa Romeo",
"Alpina",
"Alpine",
"Aston Martin",
"Audi",
"Aurus",
"Bajaj",
"Bentley",
"BMW",
"Brilliance",
"Bugatti",
"BYD",
"Cadillac",
"Caterham",
"Changan",
"Chery",
"CheryExeed",
"Chevrolet",
"Chrysler",
"Citroen",
"Daewoo",
"Daihatsu",
"Dartz Motors",
"Datsun",
"Detroit Electric",
"DFM",
"Dodge",
"DS",
"FAW",
"Ferrari",
"Fiat",
"Ford",
"Foton",
"GAC",
"GAZ",
"Geely",
"Genesis",
"GMC",
"Great Wall",
"GTA Motor",
"Hafei",
"Haima",
"Haval",
"Hawtai",
"Hennessey",
"Honda",
"Hummer",
"Hyundai",
"Icona",
"Infiniti",
"Iran Khodro",
"Isuzu",
"JAC",
"Jaguar",
"Jeep",
"KIA",
"Koenigsegg",
"Lada",
"Lamborghini",
"Land Rover",
"Lexus",
"LIFAN",
"Lincoln",
"Lotus",
"Luxgen",
"Marussia",
"Maserati",
"Maybach",
"Mazda",
"Mazzanti",
"McLaren",
"Mercedes-Benz",
"MG Cars",
"MINI",
"Mitsubishi",
"Nissan",
"Opel",
"Pagani",
"Peugeot",
"PGO",
"Porsche",
"Proton",
"Qoros",
"Ravon",
"Renault",
"Rolls-Royce",
"Saab",
"Samsung",
"SEAT",
"SeAZ",
"Skoda",
"Smart",
"SsangYong",
"Subaru",
"Suzuki"
],
// Информация о запросе
"inquiry": {
"price": 0, // Списание за запрос
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
Вывод существующих моделей автомобиля
Пример запроса "Вывод существующих моделей автомобиля" HTTP GET на URL нашего API
https://api-cloud.ru/api/autocatalog.php?type=chekmodel&marka=Peugeot&token=53ba1b7a55abbB014aa97eff3a522079
Есть данные о моделях
{
"status": 200,
"marka": "Peugeot",
"models": [
{
"name": 1007,
"id": "2932"
},
{
"name": 107,
"id": "2372"
},
{
"name": 108,
"id": "3796"
},
{
"name": 2008,
"id": "3488"
},
{
"name": 206,
"id": "2861"
},
{
"name": 207,
"id": "2380"
},
{
"name": 208,
"id": "3504"
},
{
"name": "208 GTi",
"id": "3527"
},
{
"name": 3008,
"id": "2395"
},
{
"name": 301,
"id": "3401"
},
{
"name": 307,
"id": "2915"
},
{
"name": 308,
"id": "2299"
},
{
"name": "308 GT",
"id": "4917"
},
{
"name": 4007,
"id": "2323"
},
{
"name": 4008,
"id": "3360"
},
{
"name": 406,
"id": "3108"
},
{
"name": 407,
"id": "2799"
},
{
"name": 408,
"id": "3429"
},
{
"name": 5008,
"id": "2739"
},
{
"name": 508,
"id": "2704"
},
{
"name": "508 RXH",
"id": "3384"
},
{
"name": 607,
"id": "3069"
},
{
"name": 807,
"id": "3007"
},
{
"name": "Expert",
"id": "3752"
},
{
"name": "Expert Tepee",
"id": "2878"
},
{
"name": "Landtrek",
"id": "9272"
},
{
"name": "Partner",
"id": "2658"
},
{
"name": "RCZ",
"id": "2342"
},
{
"name": "RCZ R",
"id": "3626"
},
{
"name": "Traveller",
"id": "7151"
}
],
// Информация о запросе
"inquiry": {
"price": 0.8, // Списание за запрос
"balance": 100462.11, // Баланс после текущего запроса
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
Нет данных или был передан неверный параметр model
{"error":"888","message":"marka: incorrect value"}
Вывод фотографий из каталога выбанной модели по ID
https://api-cloud.ru/api/autocatalog.php?type=carPhoto&modelid=2372&token=53ba1b7a55abbB014aa97eff3a522079
Есть данные
{
"status": 200,
"count": 2,
"rez": [
{
"name": "2012 - сегодня (I 2 рест.)",
"photos": [
"https://api-cloud.ru/api/carPhoto/9f5446da2e3f588993f50fcb781c659f.jpg",
"https://api-cloud.ru/api/carPhoto/f1b97070ee4cd8e3556270d1caf8fb18.jpg",
"https://api-cloud.ru/api/carPhoto/4250b3f734c7e2d9918cf8f8efc36485.jpg",
"https://api-cloud.ru/api/carPhoto/31d8a3b310ffab25b56ffa776cda7c06.jpg",
"https://api-cloud.ru/api/carPhoto/5e2d5c257dc06b2cb6e398bf2dd72307.jpg",
"https://api-cloud.ru/api/carPhoto/7001bbc02c49621dc23fc51c578d0d3e.jpg",
"https://api-cloud.ru/api/carPhoto/3ab625c45b0dfbb110d65c20ba9cf6e6.jpg",
"https://api-cloud.ru/api/carPhoto/6c755e3851c85f22196a47bb682d0a0c.jpg"
],
"logo": [
{
// Маленькое лого
"small": "https://api-cloud.ru/api/carPhoto/b3aa08f090c396f87e1e18bffc9ec451.jpg"
},
{
// Большое лого
"big": "https://api-cloud.ru/api/carPhoto/7f4addf39308f0bca23d603bbc5b7df6.jpg"
}
]
},
{
"name": "2005 - 2011 (I рест.)",
"photos": [
"https://api-cloud.ru/api/carPhoto/89312fb7bf8018e891a495f021060f7c.jpg",
"https://api-cloud.ru/api/carPhoto/d439d665d075ac7ab7f76cd27c0ab055.jpg",
"https://api-cloud.ru/api/carPhoto/4b9ef256f621b5ea4fe09ab3c05f31b3.jpg",
"https://api-cloud.ru/api/carPhoto/168b7275b4796c34537e225d2e1c21f5.jpg",
"https://api-cloud.ru/api/carPhoto/830b7fbba3e11dbc7fbf5bad97951df2.jpg",
"https://api-cloud.ru/api/carPhoto/7b2069f1945cbdff31270e4a3003e8ab.jpg",
"https://api-cloud.ru/api/carPhoto/453ef7e9bb0fa0ed6f3c96aad363662e.jpg",
"https://api-cloud.ru/api/carPhoto/57305f45c950a49d23cc6cc38994eeb3.jpg"
],
"logo": [
{
// Маленькое лого
"small": "https://api-cloud.ru/api/carPhoto/b3aa08f090c396f87e1e18bffc9ec451.jpg"
},
{
// Большое лого
"big": "https://api-cloud.ru/api/carPhoto/7f4addf39308f0bca23d603bbc5b7df6.jpg"
}
]
}
],
// Информация о запросе
"inquiry": {
"price": 0.8, // Списание за запрос
"balance": 100462.11, // Баланс после текущего запроса
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
Нет данных
{
"status":200,
"message":"Информация о моделях не найдена. Проверьте параметр marka",
// Информация о запросе
"inquiry": {
"price": 0.8, // Списание за запрос
"balance": 100462.11, // Баланс после текущего запроса
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
История изменений API Каталог фотографий авто
| дата | что изменилось |
|---|---|
| 16.11.2023 | Исправлена ошибка, которая гласила, что в запросе отсутствует параметр vin |
| 23.10.2022 | В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. |
| 18.11.2021 | Информация о запросе в массиве inquiry |
| 02.11.2021 | Новый вывод данных по логотипу в type->carPhoto |
| 01.11.2021 | Новый тип запроса type->modelList |
Возможные коды ошибок
| код (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 |
| 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"}