Документация по работе с API Федресурс (Банкротсва) (bankrot.fedresurs.ru)
Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/bankrot.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/bankrot.php?' . http_build_query($data);
$data = get_rez($url); // Результат ответа (JSON)
Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.
Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа
| type (Метод) | Описание | Параметры в запросе |
|---|---|---|
| В одном запросе возможно отправить только 1 тип | ||
| regionsList | Получить массив регионов для поиска |
Обязательные token - персональный ключ API |
| searchString | Поиск в базе банкротств
• Наименование лица
• Адрес
• ИНН
• СНИЛС
• Статус дела
• Номер судебного дела
• Арбитражный управляющий
• Детальная информация
В резульате максимум 15 записей |
Обязательные string - Строка поиска (Наименование лица, ИНН, номер дела) Маска: A-Za-zА-ЯЁа-яё0-9-/\s legalStatus - fiz (Физическое лицо) или legal (Юридическое лицо) token - персональный ключ API Дополнительные isActiveLegalCase - true (Поиск только по делам в производстве), false (Поиск только по завершенным делам) dopInfo - 1 (Выводить в результате дополнительную информацию по каждому делу: дата рождения, место рождения) Значение: 1 - включить |
| search | Подробная информация по делу
|
Обязательные guid - guid из результата searchString Маска: A-Za-z0-9-\s legalStatus - fiz (Физическое лицо) или legal (Юридическое лицо) token - персональный ключ API |
Примеры запросов
Поиск в базе банкротств
Пример запроса "Поиск в базе банкротств " HTTP GET на URL нашего API
Пример успешного запроса по типу searchString
https://api-cloud.ru/api/bankrot.php?type=searchString&string=Наименование лица или ИНН или номер дела&legalStatus=fiz или legal&token=53ba1b7a55abbB014aa97eff3a522079
Есть данные в базе банкроств
{
"status":200, // Статус запроса
"totalCount":1, // Количество найденных записей
// Массив с результатами
"rez":[
{
"guid":{
"title":"Идентификатор (guid) для поиска по методу search",
"value":"62e3d5dc-0000-40e7-0000-f4a912ad78f4"
},
"fio":{
"title":"ФИО",
"value":"Иванов Иван Иванович"
},
// Дополнительный запрос даты рождения (при переданном свойстве dopInfo=1)
"dopInfo-birthdateBankruptcy":{
"title":"Дата рождения",
"value":"1990-01-01T00:00:00"
},
// Дополнительный запрос места рождения (при переданном свойстве dopInfo=1)
"dopInfo-birthplaceBankruptcy":{
"title":"Место Рождения",
"value":"гор. Ульяновск"
},
"inn":{
"title":"ИНН",
"value":"732600006498"
},
"snils":{
"title":"СНИЛС",
"value":"13700003966"
},
"category":{
"title":"Категория",
"value":"Физическое лицо"
},
"region":{
"title":"Регион",
"value":"Ульяновская область"
},
"arbitrManagerFio":{
"title":"Арбитражный управляющий",
"value":"Мнеян Эрмине Арменаковна"
},
"address":{
"title":"Адрес",
"value":"432012, г. Ульяновск, пр-т. проспектов, д. 1а, кв. 0"
},
"lastLegalCasenNumber":{
"title":"Номер судебного дела",
"value":"А72-00000\/0000"
},
"status":{
"title":"Статус",
"value":"Производство по делу завершено"
},
"description":{
"title":"Описание",
"value":"Производство по делу завершено"
},
"updateDate":{
"title":"Последнее обновление",
"value":"2022-06-06T00:01:01.247"
},
"isActive":{
"title":"Статус дела (true - в производстве, false - завершено)",
"value":null
}
}
],
"inquiry":{
"price":"0.6",
"balance":18780.62,
"speed":2,
"attempts":1
}
}
Нет данных в базе банкроств
{
"status":200, // Статус ответа
"num":0, // Количество найденных записей
"message":"Информация не найдена",
"inquiry":{
"price":"0.6",
"balance":18459.62,
"speed":0,
"attempts":1
}
}
История изменений API Федресурс (Банкротсва)
| дата | что изменилось |
|---|---|
| 27.06.2023 | Адаптация под источник |
| 18.05.2023 | Метод запроса: searchString |
| 23.10.2022 | В массив inquiry добавили ключ balance. Вывод текущего баланса после запроса, позволит не отправлять дополнительные запросы на проверку баланса. |
Возможные коды ошибок
| код (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 Ошибка значения переданной даты |
| 005 | TEST_TIME_OFF Закончился период тестирования |
| 004 | MISSING_REQUIRED_isActiveLegalCase_PARAMETER Отсутствует параметр isActiveLegalCase или указан неверно |
| 003 | MISSING_REQUIRED_string_PARAMETER Отсутствует параметр string или указан неверно |
| 003 | TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой |
| 002 | MISSING_REQUIRED_legalStatus_PARAMETER Отсутствует параметр legalStatus или указан неверно |
| 002 | TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности. |
| 001 | API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже. |
| 001 | MISSING_REQUIRED_guid_PARAMETER Отсутствует параметр guid или указан неверно |
{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}
Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.
Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}