Документация по работе с API Личный кабинет
Для взаимодействия с личным кабинетом разработан отдельный функционал API.
Обратите внимание, что тестовые токены не поддерживаются API
История изменений/обновлений
| types | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| balance | Проверка баланса
• Текущий баланс
|
Обазятельные token - персональный ключ API |
| performance | Проверка работоспособности API
• Работоспособность API
• Работоспособность метода API
|
Обазятельные api - название api method - метод api (type) token - персональный ключ API |
Средства по запросу к API Личный кабинет не взимаются.
Проверка баланса
Пример запроса "Баланс" HTTP GET на URL нашего API
Пример успешного запроса по типу balance в формате JSON
https://api-cloud.ru/api/apilk.php?type=balance&token=53ba1b7a55abbB014aa97eff3a522079
{
"status":200, // Статус запроса
"balance":205.39999270439, // Текущий баланс, без округлений
}
Проверка работоспособности API
https://api-cloud.ru/api/apilk.php?type=performance&api=fssp&method=physical&token=53ba1b7a55abbB014aa97eff3a522079
{
"status":200, // Статус ответа
"api":"fssp", // API
"method":"physical", // Метод (type)
"performance":true // Статус работы (true - работает / false - не работает)
}
История изменений Личный кабинет
| дата | что изменилось |
|---|---|
| 28.03.2023 | Добавили метод запроса "performance" для проверки работоспособности 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, что-то одно. |
| 015 | DATE_ERROR Ошибка значения переданной даты |
| 008 | MISSING_REQUIRED_METHOD_PARAMETER Отсутствует параметр method |
| 007 | MISSING_REQUIRED_API_PARAMETER Отсутствует параметр api |
| 006 | API_NOT_FOUND Имя переданного API не найдено |
| 005 | TEST_TIME_OFF Закончился период тестирования |
| 001 | API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже. |
{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}
• API ГИБДД (Государственная инспекция безопасности дорожного движения)
• API Федеральная Таможенная Служба (ФТС)
• API VIN Декодер (Расшифровка данных VIN номера)
• API РСА (Российский Союз Автостраховщиков)
• API ЕАИСТО (Единая Автоматизированная Информационная система технического осмотра)
• API ФССП (Федеральная Служба Судебных Приставов)
• API Отзывные компании
• API Проверка ТС по базе такси
• API Фотографии транспортных средств
• API Каталог фотографий авто
• API Оценка стоимости автомобиля
• API МВД (Министерство Внутренних дел)
• API ФРИ (Федеральный реестр инвалидов)
• API Федеральная налоговая служба
• API Московский транспорт (transport.mos.ru)
• API Федеральный ресурс (Банкротства)
• API Росреестр
• API Bidcars (История автомобилей из США с аукционов Copart и IAAI)
• API Электронный ПТС
• API Номерограм
• API Скриншот сайта
• API Росфинмониторинг
• API Конвертер VIN<->Рег.номер
• API API ras.arbitr (Решения арбитражных судов)
• API kad.arbitr (Картотека арбитражных дел)
• API Реестр залогов
Обращаем ваше внимание, что API-CLOUD не имеет никакого отношения к ресурсам источникам*, а предоставляет вам более удобный способ взаимодействия с информацией, находящейся в открытом доступе на данных ресурсах.
