API Реестр залогов - API-CLOUD
Документация по работе с API Реестр залогов (reestr-zalogov.ru)

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/zalog.php с персональным ключом API и параметрами.
Пример отправки 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/zalog.php?' . http_build_query($data);

    $data = get_rez($url); // Результат ответа (JSON)
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
История изменений/обновлений API
Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа
type (Метод) Описание Параметры в запросе
В одном запросе возможно отправить только 1 тип По умолчанию поиск осуществляется только по актуальным сведениям из реестра уведомлений о залоге движимого имущества.
notary Проверка в реестре залогов транспортного средства
• Наличие залогов
• Информация о залогах
• Залогодатели
• Залогодержатели
Обязательные
vin - VIN номер авто и/или chassis - номер шасси и/или bodyNumber - номер кузова (минимум 1 из вариантов)
Разрешено (vin): латиница, цифры, знак "-"
Разрешено (chassis): латиница, цифры, знак "-", максимум 25 символов
Разрешено (bodyNumber): латиница, цифры, знак "-", максимум 20 символов
token - персональный ключ API
Дополнительные
allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога.
Значение: 1 - включить
page - Номер страницы для поиска (в диапазоне результата 'tatalPages' из ответа. Если tatalPages: 10, то page>1 и page<=10. При передаче несуществующей страницы ответ будет пустой, а запрос будет оплачен)
Разрешено: цифры
fedresurs Проверка в реестре на нахождение транспортного средства в лизинге
• Наличие ТС в лизинге
• Информация о лизинге
• Залогодатели
• Залогодержатели
Обязательные
vin - VIN номер авто и/или chassis - номер шасси и/или bodyNumber - номер кузова (минимум 1 из вариантов)
Разрешено (vin): латиница, цифры, знак "-"
Разрешено (chassis): латиница, цифры, знак "-", максимум 25 символов
Разрешено (bodyNumber): латиница, цифры, знак "-", максимум 20 символов
token - персональный ключ API
Дополнительные
allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога.
Значение: 1 - включить
page - Номер страницы для поиска (в диапазоне результата 'tatalPages' из ответа. Если tatalPages: 10, то page>1 и page<=10. При передаче несуществующей страницы ответ будет пустой, а запрос будет оплачен)
Разрешено: цифры
notaryPledgor Проверка в реестре залогов по залогодателю
• Наличие залогов
• Информация о залогах
• Залогодатели
• Залогодержатели
Физические лица:
Обязательные
lastname - Фамилия
Разрешено: кирилица, латиница, цифры, знак "-"
firstname - Имя
Разрешено: кирилица, латиница, цифры, знак "-"
Опционально:
secondname - Отчество
birthdate - Дата рождения в формате дд.мм.гггг
Разрешено: цифры, знак "."
Юридические лица:
Обязательные
Минимум 1 из параметров, либо все вместе:
urName - Юридическое наименование
Разрешено: кирилица, цифры
urINN - ИНН
Разрешено: цифры
urOGRN - ОГРН
Разрешено: цифры
token - персональный ключ API

Дополнительные
allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога.
Значение: 1 - включить
page - Номер страницы для поиска (в диапазоне результата 'tatalPages' из ответа. Если tatalPages: 10, то page>1 и page<=10. При передаче несуществующей страницы ответ будет пустой, а запрос будет оплачен)
Разрешено: цифры
notaryPledgorFedres Проверка в Федресурсе по залогодателю
• Наличие залогов
• Информация о залогах
• Залогодатели
• Залогодержатели
Физические лица:
Обязательные
lastname - Фамилия
Разрешено: кирилица, латиница, цифры, знак "-"
firstname - Имя
Разрешено: кирилица, латиница, цифры, знак "-"
Опционально:
secondname - Отчество
birthdate - Дата рождения в формате дд.мм.гггг
Разрешено: цифры, знак "."
Юридические лица:
Обязательные
Минимум 1 из параметров, либо все вместе:
urName - Юридическое наименование
Разрешено: кирилица, цифры
urINN - ИНН
Разрешено: цифры
urOGRN - ОГРН
Разрешено: цифры
token - персональный ключ API

Дополнительные
allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога.
Значение: 1 - включить
page - Номер страницы для поиска (в диапазоне результата 'tatalPages' из ответа. Если tatalPages: 10, то page>1 и page<=10. При передаче несуществующей страницы ответ будет пустой, а запрос будет оплачен)
Разрешено: цифры
otherNotary Проверка иного движимого имущества
• Наличие залогов
• Информация о залогах
• Залогодатели
• Залогодержатели
Обязательные
id - Буквенно-цифровое обозначение, идентифицирующее имущество
Разрешено: кирилица, латиница, цифры, знаки "- / _"
token - персональный ключ API
Дополнительные
allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога.
Значение: 1 - включить
page - Номер страницы для поиска (в диапазоне результата 'tatalPages' из ответа. Если tatalPages: 10, то page>1 и page<=10. При передаче несуществующей страницы ответ будет пустой, а запрос будет оплачен)
Разрешено: цифры
notification Уведомление о "возникновении/изменении" залога
• Ссылка на скачивание документа pdf
Обязательные
id - id из истории изменений (формат 2024-000-000000-420 или 2024-000-000000-420/1)
Разрешено: латиница, цифры, знаки "- /"
token - персональный ключ API
Примеры запросов

История изменений API Реестр-залогов

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

Метод: notification
В выводе добавлен флаг (found) успешности поиска файла.
true - файл найден, в url будет ссылка на скачивание файла /  false - не найден (например если id был указан неверно), в url будет null
Документация обновлена.

 

23.10.2024

Добавлен новый метод запроса 'notaryPledgorFedres'
Позволяет отправить запрос на поиск по залогодателю в Федресурсе.
Подробнее в документации.
 

23.10.2024

Методы notary и fedresurs:
1. Поиск теперь можно осществить не только по vin, но и по номеру шасси и номеру кузова. В запросе минимум 1 доступный вариант.
2. Появился поиск с указанием страницы. Если в результате несколько страниц, т.е. в результате больше 10 записей, то можно указать страницу по которой получаем результат.
Метод otherNotary:
Появился поиск с указанием страницы. Если в результате несколько страниц, т.е. в результате больше 10 записей, то можно указать страницу по которой получаем результат.

09.10.2024

Тип запроса 'notaryPledgor':
1. Добавлен параметр поиска 'page', позволяющий отправить запрос для получения результатов с указанной страницы.
В ответе добавлены флаги 'tatalPages' - сообщает о количестве страниц в результате поиска и 'page' - сообщает на какой странице был произведен поиск.
2. В результате поиска в массиве properties исправлен баг с некоторыми данными которые показывались как null

26.09.2024

notaryPledgor: Исправлено условие возникновения ошибки "ONE OF THE REQUIRED PARAMETERS IS MISSING"

27.04.2024

Добавлен новый метод поиска 'notaryPledgor'. Позволяет осуществить поиск по залогодателям.
Осуществить поиск можно по физическим и юридическим лицам. Подробнее в документации.

13.03.2024

Стабилизирована и ускорена обработка всех методов запросов

05.02.2023

Метод запроса: notification
1. Увеличен срок хранения pdf файлов по методу запроса notification до 15 минут.
2. Оптимизрована работа

23.10.2022

В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. 

12.10.2022

1. Провели оптимизацию
2. Восстановили работу типа запроса "notification"

26.09.2022

В документацию добавлена информация по найденным записям лизинга (type->fedresurs)

20.06.2022

В notary и fedresurs добавили кэширование.

03.06.2022

Оптимизированы алгоритмы работы

06.05.2022

Ускорили в разы работу. Работает быстрее и стабильнее.

13.01.2022

Тип запроса: notary
В массив pledgors добавлен отличительный параметр залогодателя: Физическое лицо, Юридическое лицо
Добавлен в вывод новый массив "properties" - имущество в залоге

06.12.2021

Частая ошибка TIME_MAX_CONNECT. Некорректный регистр VIN параметра
При попытке получить данные по VIN в нижнем регистре возникала ошибка таймаута. Решили переводом параметра в верхний регистр.

18.11.2021

Информация о запросе в массиве inquiry
Добавлен статус ответа, а так же информация о запросе: Тариф, скорость, количество попыток

21.10.2021

Новые параметр в запросах "allChanges=1"
Для type->notary, type->fedresurs, type->otherNotary реализован дополнительный параметр "allChanges". Передавайте его, чтобы осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога

30.09.2021

Новые тип запроса type->notifications
Получение документа, уведомление о "возникновении/изменении" залога

30.09.2021

Новые данные в type->otherNotary
Стала доступна история изменения статусов залога

30.09.2021

Новые данные в type->notary
Стала доступна история изменения статусов залога

27.09.2021

Добавленый новый тип запроса type->otherNotary
Поиск иного движимого имущества

20.09.2021

Изменены алгориты забора информации по type->fedresurs

17.09.2021

Восстановлена работа API. Ранее не выводило результата.

19.04.2021

Добавили type=fedresurs, данный тип позволяет осуществить поиск ТС в базе на наличие лизинга.

19.04.2021

Восстановили работоспособность модуля

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

код (error) Описание ошибки (message)
888 ИМЯ передаваемой переменной: forbidden symbols present
В переменной ИМЯ присутствуют запрещенные символы
766 MISSING_MANDATORY_PARAMETER
Отсутствуют обязательные параметры
710 page: forbidden symbols present
В параметре 'page' присутствуют запрещенные символы
709 MISSING PARAMETERS
Не передан ни один из параметров
708 ONE OF THE REQUIRED PARAMETERS IS MISSING
Отсутствует один из обязательных параметров
707 urOGRN: forbidden symbols present
В параметре urOGRN присутствуют запрещенные символы
706 MISSING_REQUIRED_inn_PARAMETER
Параметр inn передан с ошибками или не соответствует маске
705 urName: forbidden symbols present
В параметре urName присутствуют запрещенные символы
704 MISSING_REQUIRED_lastname_PARAMETER
Отсутствует обязательный параметр lastname
703 MISSING_REQUIRED_firstname_PARAMETER
Отсутствует обязательный параметр firstname
702 secondname: forbidden symbols present
В параметре secondname присутствуют запрещенные символы
701 lastname: forbidden symbols present
В параметре lastname присутствуют запрещенные символы
700 firstname: forbidden symbols present
В параметре firstname присутствуют запрещенные символы
602 TOKEN_NO_ACCESS
Нет доступа к запрашиваему методу запроса
504 TOKEN_LOCKED_IN_THE_SYSTEM
Переданный токен заблокирован службой качества / автоматической системой
503 TOKEN_NOT_REGISTERED_IN_THE_SYSTEM
Переданный токен не зарегистрирован в системе
502 MISSING_REQUIRED_TOKEN_PARAMETER
Отсутствует параметр token
501 MISSING_REQUIRED_VIN_PARAMETER
Отсутствует параметр vin или указан неверно
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
Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже.
300 MISSING_REQUIRED_ID_PARAMETER
Отсутствует параметр id или указан неверно
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"}