API Автодор: Платные дороги

Документация по работе с API Автодор: Платные дороги

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

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

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

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

type Обязательно	Описание	Параметры в запросе Обязательно
	В одном запросе возможно отправить только 1 тип
payCheck ^beta!	Посмотреть начисление оплаты проезда по госномеру на ЦКАД, М-12 и А-289 🔑 Найдена задолженность Да/Нет 🔑 Сумма оплаты	Обязательные gosNumber - Регистрационный знак Разрешенная маска: [/^[АВЕКМНОРСТУХ]\d{3}[АВЕКМНОРСТУХ]{2}\d{2,3}$/u], например А111АА11 Разрешенная маска: [/^[АВЕКМНОРСТУХ]{2}\d{3}(?< !000)\d{2,3}$/u], например АА11122 (такси) 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/avtodor.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":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

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

Посмотреть начисление оплаты проезда по госномеру на ЦКАД, М-12 и А-289

Пример запроса "Посмотреть начисление оплаты проезда по госномеру на ЦКАД, М-12 и А-289 " HTTP GET на URL нашего API

https://api-cloud.ru/api/avtodor.php?type=payCheck&gosNumber=А111АА11&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу payCheck в формате JSON
Есть данные

{
  "status": 200, // Статус ответа
  "found": false, // Статус поиска задолженности (true - найдена / false - не найдена)
  "total": 0, // Сумма задолженности
  "inquiry": {
    "price": 0.2,
    "balance": 5675.02,
    "credit": 20000,
    "speed": 3,
    "attempts": 1
  }
}

История изменений API Автодор: Платные дороги

дата	что изменилось

Возможные коды ошибок

код (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"}