API Проверка ТС по базе Такси

Документация по работе с API Проверка ТС по базе такси

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.

История изменений/обновлений API

Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа

HTTPS GET запрос: https://api-cloud.ru/api/taxi/v3/taxi.php
Обязательно использовать HTTPS протокол, иначе запросы будут дублироваться при перенаправлении с HTTP на HTTPS.
Обязательно использовать GET запрос, иначе мы не увидим параметры, которые вы передаете.

Поиск по локальной базе и по базам партнеров

type Обязательно	Описание	Параметры в запросе Обязательно
	В одном запросе возможно отправить только 1 тип
search	Проверка ТС на факт работы в такси Обратите внимание! Необходимо брать во внимание массив партнера (partner). Массив local больше не поддерживается. Рекомендуем совмещать проверки с API ФГИС "Такси", официальным источником реестра Такси Проверка ТС по VIN номеру Проверка ТС по номеру кузова номеру	Обязательные string - Гос. номер или VIN номер или номер кузова. Разрешено: кириллица, латиница, цифры token - персональный ключ API

Токен (token) можно передавать в заголовках (headers). Указываем в заголовке Token: ВАШ_ТОКЕН

Пример отправки 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/taxi/v3/taxi.php?' . http_build_query($data);

    $data = get_rez($url); // Результат ответа (JSON)

Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.

При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.

Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

Примеры запросов

Основная информация

Пример запроса "Проверка ТС по базе Такси" HTTP GET на URL нашего API

https://api-cloud.ru/api/taxi/v3/taxi.php?type=search&string=С8111МУ11&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу search по базе такси в формате JSON


{
  "status": 200, // Общий статус ответа
  // Массив с данными партнера (обновляется каждый день). В первую очередь необходимо брать эти данные.
  "partner": {
    "status": 200, // Статус ответа
    "found": true, // Признак найдено (true / false)
    // Массив с найденными данными
    "result": [
      {
        "datestamp": 1651245937, // Дата добавления в базу
        "vin": "XW7BN4FK30S112105", // VIN номер
        "regNumber": "НК83677", // Гос. номера
        "carLabel": "TOYOTA", // Марка ТС
        "carModel": "CAMRY", // Модель ТС
        "year": 2017, // Год выпуска
        "category": "B", // Категория ТС
        // Информация об автопарке
        "info": {
          "brend": null, // Название
          // Данные компании
          "company": {
            "inn": null, // ИНН
            "kpp": null // КПП
          }
        },
        // Кузов
        "frame": {
          "color": "ЖЁЛТЫЙ", // Цвет
          "number": "XW7BN4FK30S112105" // Номер кузова
        },
        // Двигатель
        "engine": {
          "number": "P368379", // Номер
          "volume": "1998.0" // Объем двигателя
        },
        "power": {
          "hp": "150.0",
          "kwt": "110.300"
        }
      }
    ]
  },
  // Массив с локальными данными (обновляется раз в месяц)
  "local": {
    "status": 200, // Статус ответа
    "found": true, // Признак найдено (true / false)
    // Массив с найденными данными
    "result": [
      {
"vin":"", // VIN номер ТС при наличии
"regNumber":"ЕМ50377", // Регистрационный номер ТС
"permitNumber":"7646", // Номер разрешения
"perevoz":"ООО «НЖТ-ЮГ»", // Перевозчик, владелец лицензии
"carLabel":"Форд Фокус", // Марка и модель ТС
"year":"2011", // Год выпуска ТС
"color":"", // Цвет ТС
"dateFrom":"13.09.2011", // Дата выдачи разрешения
"dateTo":"12.09.2016", // Дата окончания разрешения
"dateToNow":"", // Дата прекращения разрешения
"status":"Истек срок действия", // Статус разрешения
"regionName":"г. Москва" // Региональная принадлежность
      }
    ]
  },
  // Информация о запросе
  "inquiry": {
    "price": 0.5, // Стоимость
    "balance": 100462.11, // Баланс после текущего запроса
    "credit": "0.00", // Кредитный лимит (сумма лимита расходов при нуле)
    "speed": 0, // Скорость
    "attempts": 1 // Количество попыток
  }
}

Данные в базе по такси отсутствуют на запрошенное ТС

{
  "status": 200,
  "partner": {
    "status": 200,
    "found": false,
    "message": "В базе такси не найдено"
  },
  "local": {
    "status": 200,
    "found": false,
    "message": "В базе такси не найдено"
  },
  "inquiry": {
    "price": 0.4,
    "balance": 100462.11, // Баланс после текущего запроса
    "credit": "0.00", // Кредитный лимит (сумма лимита расходов при нуле)
    "speed": 0,
    "attempts": 1
  }
}

История изменений Проверка ТС по базе такси

дата	что изменилось
11.07.2023	Возобновлена проверка по базе партнера. Массив partner
01.05.2023	Приостановлен вывод результата по партнеру (массив partner) Поиск будет осуществляться только по локальной базе (массив local)
23.10.2022	В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса.
22.03.2022	Выпущена версия (v2). Поддержка (v1) прекращена. Документация приведена в соответствие с версией. Цена на запросы снижена! Обратите внимание, что необходимо произвести корректировку кода согласно новой версии API.
22.07.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, что-то одно.
15	DATE_ERROR Ошибка значения переданной даты
5	TEST_TIME_OFF Закончился период тестирования
3	TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой
2	TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности.
1	API_SUSPENDED Работа этого API или метода временно приостановлена. Это значит, что источник не отвечает. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже.

Пример ответа с ошибкой

{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}