Документация по работе с API Фотографии транспортных средств
Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/autophoto.php с персональным ключом API и параметрами.
Пример отправки GET запроса на PHP:
function get_rez($url) {
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
curl_setopt($ch,CURLOPT_TIMEOUT,200); // Таймаут необходим, поскольку 30 секунд может не хватить и вы не получите ответ
$res = curl_exec($ch);
curl_close($ch);
return $res;
}
$data = [
'type' => 'Тип запроса (type)',
...
Необходимы для запроса параметры
...
'token' => 'Токен',
];
// Структурированная ссылка для GET запроса
$url = 'https://api-cloud.ru/api/autophoto.php?' . http_build_query($data);
$data = get_rez($url); // Результат ответа (JSON)
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 200 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа
| type (Метод) | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| regnum | Проверка фотографий по Регистрационному номеру
• Количество фотографий
• Название фото
• Дата добавления
• Ссылки на фото в миниатюре
• Ссылка на фото в оригинале
• Ссылка на фото рег. номера
|
Обязательные regNum - регистрационный номер транспортного средства Разрешено: латиница, цифры token - персональный ключ API |
Важная информация:
Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источникаПри подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200, т.е. получили результат. Даже если вы получили в ответе count => 0 и фотографии не найдены, то такой запрос так же оплачивается согласно тарифу.
Примеры запросов
Основная информация Отзывной компании по VIN номеру
Пример запроса "Проверка отзывной компании по VIN коду" HTTP GET на URL нашего API
Пример успешного запроса по типу vin с сайта Отзывных компаний в формате JSON
https://api-cloud.ru/api/autophoto.php?type=regnum®Num=XXXXXXXX&token=53ba1b7a55abbB014aa97*****22079
Есть данные
{
// Статус ответа
"status": 200,
// Количество фотографий
"count": 6,
// Записи с фото, сортировка от новых фото к старым
"records": [
{
// Маленькая фотография (время жизни ссылок 10 минут)
"urlphoto": "http://url/file.jpg",
// Большая фотография (время жизни ссылок 10 минут)
"bigPhoto": "http://url/file.jpg",
// Фотография рег. номера (время жизни ссылок 10 минут)
"urlNumber": "http://url/file.jpg",
// Название фото
"info": "Land Rover Range Rover",
// Дата добавления
"add": " 2019-05-20 22:32:02"
},
{
"urlphoto": "http://url/file.jpg",
"bigPhoto": "http://url/file.jpg",
"urlNumber": "http://url/file.jpg",
"info": "Land Rover Range Rover",
"add": " 2017-10-09 21:22:26"
},
{
"urlphoto": "http://url/file.jpg",
"bigPhoto": "http://url/file.jpg",
"urlNumber": "http://url/file.jpg",
"info": "Audi Q7",
"add": " 2013-03-23 09:11:12"
},
{
"urlphoto": "http://url/file.jpg",
"bigPhoto": "http://url/file.jpg",
"urlNumber": "http://url/file.jpg",
"info": "BMW X5",
"add": " 2012-11-23 22:09:17"
},
{
"urlphoto": "http://url/file.jpg",
"bigPhoto": "http://url/file.jpg",
"urlNumber": "http://url/file.jpg",
"info": "Toyota Land Cruiser Prado",
"add": " 2012-02-18 15:18:21"
},
{
"urlphoto": "http://url/file.jpg",
"bigPhoto": "http://url/file.jpg",
"urlNumber": "http://url/file.jpg",
"info": "Mitsubishi Pajero",
"add": " 2008-03-22 08:26:02"
}
],
// Информация о запросе
"inquiry": {
"price": 0.8, // Списание за запрос
"balance": 100462.11, // Баланс после текущего запроса
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
Фотографии отсутствуют
{
"status": 200,
"count": 0,
"message": "Фотографии по транспортному средству не найдены",
// Информация о запросе
"inquiry": {
"price": 0.8, // Списание за запрос
"balance": 100462.11, // Баланс после текущего запроса
"speed": 1, // Скорость запроса
"attempts": 1 // Попыток
}
}
Поиск не дал результатов, либо ресурс не вернул ответа за отведенный промежуток времени
{"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}
История изменений API Фотографии транспортных средств
| дата | что изменилось |
|---|---|
| 25.04.2024 | Восстановлена работа в режиме тестирования. |
| 23.10.2022 | В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. |
| 01.04.2022 | Апдейт взаимодействия с источником. |
| 18.11.2021 | Информация о запросе в массиве inquiry |
| 22.04.2021 | Параметр для отображения больших фотографий - bigPhoto убран. Теперь большие фотографии выводятся в запросе без дополнительных оплат. |
| 17.04.2021 | Добавили проверку доступности сервиса решения капч. Если сервис недоступен, то средства за запрос не снимаются. Вы сможете отправить запрос позднее, когда сервис будет вновь доступен. |
Возможные коды ошибок
| код (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"}