API Реестр залогов

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

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/zalog.php с персональным ключом API и параметрами.
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
История изменений/обновлений

type (тип)	Описание	Параметры в запросе
	В одном запросе возможно отправить только 1 тип	По умолчанию поиск осуществляется только по актуальным сведениям из реестра уведомлений о залоге движимого имущества.
notary	Проверка в реестре залогов по VIN номеру • Наличие залогов • Информация о залогах • Залогодатели • Залогодержатели	Обязательные vin - VIN номер авто Разрешено: латиница, цифры, знак "-" token - персональный ключ API Дополнительные allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога. Значение: 1 - включить
notaryPledgor ^new!	Проверка в реестре залогов по залогодателю • Наличие залогов • Информация о залогах • Залогодатели • Залогодержатели	Физические лица: Обязательные lastname - Фамилия Разрешено: кирилица, латиница, цифры, знак "-" firstname - Имя Разрешено: кирилица, латиница, цифры, знак "-" Опционально: secondname - Отчество birthdate - Дата рождения в формате дд.мм.гггг Разрешено: цифры, знак "." Юридические лица: Обязательные Минимум 1 из параметров, либо все вместе: urName - Юридическое наименование Разрешено: кирилица, цифры urINN - ИНН Разрешено: цифры urOGRN - ОГРН Разрешено: цифры token - персональный ключ API Дополнительные allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога. Значение: 1 - включить
fedresurs	Проверка в реестре на нахождение ТС в лизинге по VIN номеру • Наличие ТС в лизинге • Информация о лизинге • Залогодатели • Залогодержатели	Обязательные vin - VIN номер авто Разрешено: латиница, цифры, знак "-" token - персональный ключ API Дополнительные allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога. Значение: 1 - включить
otherNotary	Проверка иного движимого имущества • Наличие залогов • Информация о залогах • Залогодатели • Залогодержатели	Обязательные id - Буквенно-цифровое обозначение, идентифицирующее имущество Разрешено: латиница, цифры, знак "-" token - персональный ключ API Дополнительные allChanges - Осуществить поиск информации о предмете залога во всех уведомлениях о залоге, включая уведомления об изменении/исключении сведений об указанном предмете залога. Значение: 1 - включить
notification	Уведомление о "возникновении/изменении" залога • Ссылка на скачивание документа pdf	Обязательные id - id из истории изменений Разрешено: латиница, цифры, знак "-" token - персональный ключ API

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

Проверка залогов по VIN номеру

Пример запроса "Проверка в реестре залогов по VIN номеру" HTTP GET на URL нашего API

https://api-cloud.ru/api/zalog.php?type=notary&vin=WBALW31030C540031&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу notary с сайта Реестр залогов в формате JSON

{
  "status": 200, // Статус ответа
  "num": 1, // Количество результата
  // Массив с данными
  "rez": [
    {
	  // Дата записи
      "regDate": "11.06.2019 13:12:39",
	  // Залогодатель
      "pledgors": [
        {
          "name": "Юлия Сергеевна ********", // Имя физ лица или организации
		  "nameDetal": "Физическое лицо", // Физическое лицо, Юридическое лицо
          "birthday": "1*.06.1***" // Дата рождения
		  
        }
      ],
	  // Залогодержатель
      "pledgees": [
        {
          "name": "Общество с ограниченной ответственностью \"*********\""
        }
      ],
	  // Имущество
	  "properties":[
		{
		"vin":"XTA219070K0562441"
		}
	],
	  // История изменений
      "history": [
        {
          "id": "2019-003-714590-094", // id
          "regDate": "2019-06-11T13:12:39", // Дата регистрации
          "regDateUnix": 1560247959, // Дата регистрации в UNIX
          "type": "CREATION", // Тип записи
          "typeTitle": "Возникновение" // Расшифровка типа записи
        },
        {
          "id": "2019-003-714590-094/1",
          "regDate": "2021-09-23T16:32:18",
          "regDateUnix": 1632403938,
          "type": "CHANGE",
          "typeTitle": "Изменение"
        }
      ]
    }
  ],
  // Информация о запросе
	"inquiry": {
    "price": 0.8, // Списание за запрос
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 1, // Скорость запроса
    "attempts": 1 // Попыток
  }
}

Если в залогах vin номер не найден

{
	"status":200,
	"num":0,
	"message":"В базе залогов не найдено",
	// Информация о запросе
	"inquiry": {
    "price": 0.8, // Списание за запрос
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 1, // Скорость запроса
    "attempts": 1 // Попыток
  }
}

Проверка на наличие ТС в лизинге по VIN номеру

Пример запроса "Проверка в реестре лизинга по VIN номеру" HTTP GET на URL нашего API

https://api-cloud.ru/api/zalog.php?type=fedresurs&vin=WBALW31030C540031&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу fedresurs формате JSON

{
  "status": 200, //  Статус запроса
  "num": 1, // Количество записей
   // Массив с результатми
  "rez": {
    "total": 1, // Нумерация записи
    "data": [
      {
        "id": "056540000", // Номер сообщения 
        "regDate": "2020-11-27T15:31:39.227", //  Дата публикации
        // Имущество
        "properties": [
          {
            "otherProperty": {
              "id": "XW8AD4NH5EK100500"
            }
          }
        ],
        // Лизингополучатели
        "pledgors": [
          {
            "privatePerson": {
              "name": "Алексей",
              "birthday": "1979-11-06"
            },
            "type": "Lessee",
            "publicationDisclaimer": false
          }
        ],
        // Лизингодатели
        "pledgees": [
          {
            "organization": {
              "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"ПЕРВЫЙ ЛИЗИНГОВЫЙ ЦЕНТР\""
            },
            "type": "Lessor",
            "publicationDisclaimer": false
          }
        ],
        "guid": "F2E6C6DDFE724E9191B792DDF6D9A000",
        "link": "/api/search/redirect/F2E6C6DDFE724E9191B792DDF6D9A000"
      }
    ]
  },
  "inquiry": {
    "price": 0.6,
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 20,
    "attempts": 1
  }
}

Если в лизинге vin номер не найден

{
	"status":200,
	"num":0,
	"message":"Авто в базе лизинга не найдено",
	// Информация о запросе
	"inquiry": {
    "price": 0.8, // Списание за запрос
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 1, // Скорость запроса
    "attempts": 1 // Попыток
  }
}

Проверка иного движимого имущества

Пример запроса "Проверка в реестре лизинга по VIN номеру" HTTP GET на URL нашего API

https://api-cloud.ru/api/zalog.php?type=otherNotary&id=95789335&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу otherNotary формате JSON

{
  "status": 200, // Статус ответа
  "num": 1, // Количество результата
  // Массив с данными
  "rez": [
    {
      "regDate": "30.04.2019 21:02:30",
      "properties": [
        {
          "id": "95495883"
        },
        {
          "id": "95501136"
        },
        {
          "id": "95501458"
        },
        {
          "id": "95894150"
        },
        {
          "id": "95894200"
        },
        {
          "id": "95894226"
        },
        {
          "id": "95895173"
        },
        {
          "id": "95895181"
        },
        {
          "id": "95895207"
        }
      ],
      "pledgors": [
        {
          "organization": "публичное акционерное общество Государственная транспортная лизинговая компания"
        }
      ],
      "pledgees": [
        {
          "name": "Акционерное общество «Всероссийский банк развития регионов»"
        }
      ],
	  // История изменений
	  "history": [
        {
          "id": "2019-003-599590-282",
          "regDate": "2019-04-30T21:02:30",
          "regDateUnix": 1556647350,
          "type": "CREATION",
          "typeTitle": "Возникновение"
        }
      ],
	  // Информация о запросе
	"inquiry": {
    "price": 0.8, // Списание за запрос
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 1, // Скорость запроса
    "attempts": 1 // Попыток
	}
    }
  ]
}

Получение документа, уведомление о "возникновении/изменении"

https://api-cloud.ru/api/zalog.php?type=notification&id=2019-003-591110-282&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу notification формате JSON

{
  "status": 200, // Статус ответа
  // Ссылка с файлом для скачивания
  "url": "https://api-cloud.ru/notifications/5ec2f8513db5d161117b47ba27fdab09.pdf",
  "info": "Файл будет доступен по ссылке 15 минут",
	// Информация о запросе
	"inquiry": {
    "price": 0.8, // Списание за запрос
    "balance": 100462.11, // Баланс после текущего запроса
    "speed": 1, // Скорость запроса
    "attempts": 1 // Попыток
  }
}

Ресурс не вернул ответа за отведенный промежуток времени

{"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

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

дата	что изменилось
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 Отсутствуют обязательные параметры
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 Закончился период тестирования
001	API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже.

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

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

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

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