Api бдип фссп россии что это
Описание интерфейса программирования приложений в информационно-телекоммуникационной сети интернет для доступа к общедоступным сведениям банка данных в исполнительном производстве ФССП России
Термины и сокращения
Термин / сокращение | Описание |
API | Application Programming Interface,интерфейс программирования приложений |
БДИП | Банк данных в исполнительном производстве |
ИП | Исполнительное производство |
CURL | Служебная программа командной строки, позволяющая взаимодействовать с сервером по различным протоколам с синтаксисом URL |
JSON | Javascript Object Notation, основанный на синтаксисе Javascript формат обмена данными |
HTTPS | HyperText Transfer Protocol Secure, расширение протокола HTTP с поддержкой шифрования |
REST | Representational State Transfer, архитектурный стиль организации сетевого взаимодействия |
1. Основание для разработки
Публичный API доступа к банку данных исполнительных производств разработан во исполнение пункта 7.4 Порядка создания и ведения банка данных в исполнительном производстве Федеральной службы судебных приставов, утвержденного приказом Федеральной службы судебных приставов от 12 мая 2012 г. № 248 (в редакции приказа от 27.12.2017 № 676).
2. Назначение интерфейса программирования приложений
Назначение интерфейса программирования приложений — обеспечение возможности получения отдельных видов сведений БДИП сторонними информационными системами. Возможно получение следующих сведений:
3. Процедура регистрации
4. Общие сведения о работе API
Предоставляемый API доступа выполнен в архитектурном стиле REST, принимает HTTPS-запросы, возвращает результаты в формате JSON
Предоставляемый API:
Авторизация подразумевает необходимость передавать в каждом запросе ключ доступа (токен), получаемый при регистрации. Подробнее процедура регистрации пользователя описана в разделе 3..
Асинхронность API означает, что в ответ на подачу запроса пользователю передается идентификатор, по которому пользователь отдельными методами должен будет определить статус выполнения запроса и получить ответ.
Групповые (пакетные) запросы — запросы, дающие возможность указать одновременно несколько наборов значений параметров («подзапросов»). Устанавливается ограничение на количество подзапросов в групповом запросе.
5. Описание методов API
5.1. «Запрос на поиск сведений о физическом лице»
GET /search/physical
Параметр запроса | Описание параметра |
---|---|
token * | Ключ доступа к API, полученный при регистрации |
region * | Код региона отдела судебных приставов, ведущего ИП, в соответствии со справочником регионов ФССП России |
firstname * | Имя должника по исполнительному производству |
secondname | Отчество должника по исполнительному производству |
lastname * | Фамилия должника по исполнительному производству |
birthdate * | Дата рождения должника в формате «дд.мм.гггг» |
CURL-пример запроса приводится в разделе 6.1.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/physical:
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5. и 5.6..
5.2. «Запрос на поиск сведений о юридическом лице»
GET /search/legal
Параметр запроса | Описание параметра |
---|---|
token * | Ключ доступа к API, полученный при регистрации |
region * | Код региона отдела судебных приставов, ведущего ИП, в соответствии со справочником регионов ФССП России |
name * | Фрагмент названия должника — юридического лица |
address | Фрагмент юридического адреса юридического лица |
CURL-пример запроса приводится в разделе 6.2..
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/legal:
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5. и 5.6..
5.3. «Запрос на поиск сведений об исполнительном производстве»
GET /search/ip
CURL-пример запроса приводится в разделе 6.3..
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/ip:
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5. и 5.6..
5.4. «Групповой запрос на поиск информации в БДИП»
POST /search/group
Групповой запрос подается HTTP-методом POST. Тело запроса содержит JSON-объект с двумя полями: token и request.
Значением token является ключ доступа к API, передавать его как GET-параметр при групповом запросе не следует.
Значением request является массив объектов, соответствующих отдельным запросам, каждый такой объект имеет два поля: request[].type и request[].params.
Значение request[].type указывает тип запроса:
Значением request[].params должен быть набор пар ключ-значение, где ключами являются названия параметров соответствующих запросов 5.1.–5.3., а значениями — значения этих параметров.
Пример тела группового запроса на поиск информации приводится ниже.
CURL-пример запроса приводится в разделе 6.4.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/group:
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5. и 5.6..
5.5. «Проверка статуса поданного запроса»
GET /status
Параметр запроса | Описание параметра |
---|---|
token * | Ключ доступа к API, полученный при регистрации |
task * | Идентификатор отправленного запроса |
CURL-пример запроса приводится в разделе 6.5.
В штатном режиме функционирования API возможны следующие ответы:
В последнем случае ответ сервиса имеет вид как в примере ниже.
5.6. «Получение результатов поданного запроса»
GET /result
Параметр запроса | Описание параметра |
---|---|
token * | Ключ доступа к API, полученный при регистрации |
task * | Идентификатор отправленного запроса |
CURL-пример запроса приводится в разделе 6.6..
Для группового запроса ответ выглядит как в примере ниже.
Для единичных запросов (см. разделы 5.1.–5.3.) response.result содержит единственный элемент.
6. Примеры запросов
Дополнительные справочные материалы по использованию методов API размещены на официальном интернет-сайте ФССП России. Способ размещения этих материалов дает пользователю API возможность подавать к API тестовые запросы.
Ниже приводятся примеры запросов к методам API с помощью утилиты командной строки CURL. Во всех примерах ниже значение параметра token («yourapikey») следует заменить на полученный при регистрации ключ доступа.
6.1. «Запрос на поиск сведений о физическом лице»
6.2. «Запрос на поиск сведений о юридическом лице»
6.3. «Запрос на поиск сведений об исполнительном производстве»
6.4. «Групповой запрос на поиск информации в БДИП
6.5. «Проверка статуса поданного запроса»
6.6. «Получение результатов поданного запроса»
7. Иные условия предоставления доступа к API
Максимальное число подзапросов в групповом запросе — 50 (если требуется отправить большее число, следует разбивать запрос на несколько).
Максимальное число одиночных запросов в час — 100. (Ограничение на одиночные запросы считается, как минус час от текущего времени)
Максимальное число одиночных запросов в сутки — 1000. (Ограничение на одиночные запросы считается, как минус сутки от текущего времени)
Максимальное число групповых запросов в сутки — 5000.
Срок хранения результатов запроса (промежуток между обращениями к методам /search/ и методу /result) — 24 часа.
Проверка по банку данных исполнительных производств ФССП России из 1С 8
Реализация работы с публичным API доступа к банку исполнительных производств ФССП России.
Описание API можно скачать здесь.
Возможно получение следующих сведений:
Для доступа к API требуется пройти процедуру регистрации на официальном сайте ( ссылка на страницу регистрации есть также на форме обработки на закладке
«Настройки». Процедура занимает меньше минуты. Полученный токен нужно будет один раз указать на форме обработки в соответствующем поле.
Токен выдается на 1 год. В любой момент пользователь может начать использовать в обработке другой токен если старый утрачен или заблокирован.
Что плохого?
В этом случае прям из обработки по кнопке можно попробовать запустить страницу сервиса поиска по БДИП на официальном сайте ФССП.
Что хорошего?
Если в конфигурации в которой открыта обработка, существует хотя бы один из справочников: «Контрагенты», «Организации» или «ФизическиеЛица», то кроме
ручного указания параметров запросов будет возможно автозаполнение параметров запроса при выборе соответствующего элемента справочника.
Обработка разрабатывалась изначально для конфигурации с типовым справочником «ФизическиеЛица» и при автозаполнении параметры ФИО и дата рождения
заполняются корректно. Регион поиска предлагается в соответствии с кодом региона взятым из ИНН. Это следует учитывать.
Наличие API открывает большие возможности по интеграции с системами на 1С.
UPDATE
Добавлена демо-версия для обычного приложения. Ограничен срок действия. Ограничено количество регионов для поиска и некоторые поля результата скрыты.
Код в демо-версии обфусцирован.
Причины купить
Хороший инструмент для специалистов служб безопасности, сотрудников кадровых служб, менеджеров, управленцев и бухгалтеров.
Продукт разработан программистом имеющим несколько сертификатов 1С-Совместимо на различные успешные разработки для 1С.
Продукт может быть использован для ускорения интеграции 1С-систем компаний с API ФССП.
Код полностью открыт.
Достоинства
Разработано с учетом пожеланий специалистов служб безопасности.
Сделано для комфортной работы.
Гарантия возврата денег
ООО «Инфостарт» гарантирует Вам 100% возврат оплаты, если программа не соответствует заявленному функционалу из описания. Деньги можно вернуть в полном объеме, если вы заявите об этом в течение 14-ти дней со дня поступления денег на наш счет.
Программа настолько проверена в работе, что мы с полной уверенностью можем дать такую гарантию. Мы хотим, чтобы все наши покупатели оставались довольны покупкой.
Для возврата оплаты просто свяжитесь с нами.
API-ФССП
Доступ к исполнительным производствам ЮЛ
Сервис API-ФССП предназначен для интеграции сведений Федеральной службы судебных приставов (ФССП России) об исполнительных производствах в отношении физических и юридических лиц, в любые информационные системы.
С помощью сервиса вы сможете внедрить в ваши информационные системы сведения о действующих и законченных исполнительных производствах, их участниках, истории рассмотрения дел и результатах, а также проверить участие контрагента в исполнительных производствах.
Сервис API ФССП поможет автоматизировать заполнение раздела «Исполнительные производства» контрагента или заемщика в отчете о комплексной проверке компании, а также проводить анализ исполнительных производств, в которых участвуют или участвовали контрагенты вашей организации.
Программные интерфейсы
Название метода | Команда | Описание |
---|---|---|
Информация об исполнительном производстве | isp | Возвращает информацию об исполнительном производстве (индивидуальном или сводном) по его регистрационному номеру |
Информация об участиях ЮЛ в исполнительных производствах | isps | Возвращает информацию о текущих и бывших участиях юридического лица в исполнительных производствах |
Информация об участиях ФЛ в исполнительных производствах | ispsfl | Возвращает информацию об участиях физического лица в исполнительных производствах |
Информация об исполнительном производстве (isp)
Позволяет получить актуальную информацию об исполнительном производстве ЮЛ по его идентификационному номеру, а также историю изменения данных в ходе исполнительного производства.
На вход подается номер исполнительного производства, на выходе – строка JSON.
Используется запрос GET.
Параметр | Тип данных и пример | Описание |
---|---|---|
regn | string regn=587808/20/01020-ИП regn=1284875/20/77058-СД | Номер исполнительного производства (индивидуального или сводного) |
key | string key=67ac454f6a3fa85355aee5e41b6d154efc589aab | Ваш ключ доступа к API |
Возвращаемый документ (HTTP response) представляет собой структурированный документ JSON, содержащий информацию об исполнительном производстве.
Поля возвращаемого документа
Информация об участиях ЮЛ в исполнительных производствах (isps)
Позволяет получить информацию об исполнительных производствах (как действительных, так и завершенных) юридического лица.
На вход подается ИНН компании, на выходе – строка JSON.
Используется запрос GET.
Параметр | Тип данных и пример | Описание |
---|---|---|
inn | string inn=7721503606 | ИНН организации |
from_date | string from_date=2020-01-01 | Дата возбуждения исполнительного производства, после которой искать, в формате YYYY-MM-DD |
to_date | string to_date=2020-12-31 | Дата возбуждения исполнительного производства, до которой искать, в формате YYYY-MM-DD |
format | integer format=1 | Тип формата возвращаемых данных. Возможные значения параметра: 1 – выводить результаты в группированном виде 2 – выводить негруппированный список исполнительных производств (значение по умолчанию) |
page | integer page=2 | Номер страницы в списке найденных исполнительных производств (на каждой странице выводится не более 100). По умолчанию равен 1 |
key | string key=67ac454f6a3fa85355aee5e41b6d154efc589aab | Ваш ключ доступа к API |
Возвращаемый документ (HTTP response) представляет собой структурированный документ JSON, содержащий информацию об исполнительных производствах (как действующих, так и завершенных) в отношении юридического лица.
Поля возвращаемого документа
format=1 (группированные данные):
Имя | Тип | Описание |
---|---|---|
ИНН | object | Указанный в запросе ИНН компании |
Год | object | Год возбуждения исполнительного производства в формате YYYY (например, 2018, 2019 и т.д.) |
Статус | object | Статус исполнительного производства (Завершено, Не завершено, Погашено) |
Предмет | object | Предмет исполнения исполнительного документа (взыскание налогов и сборов, задолженность по кредитным платежам, страховые взносы, пени, штраф ГИБДД и пр.) |
Сумма | float | Сумма задолженности (в рублях) |
Количество | integer | Количество исполнительных производств |
ИП | array | Список номеров исполнительных производств |
format=2 (негруппированные данные):
Информация об участиях ФЛ в исполнительных производствах (ispsfl)
Позволяет получить информацию об исполнительных производствах (как действительных, так и завершенных) физического лица.
На вход подаются регион, ФИО и дата рождения должника, на выходе – строка JSON.
Используется запрос GET.
Параметр | Тип данных и пример | Описание |
---|---|---|
region | integer region=77 | Код региона отдела судебных приставов, ведущего исполнительное производство |
fam | string nam=Иванов | Фамилия должника |
nam | string nam=Михаил | Имя должника |
otch | string nam=Петрович | Отчество должника (необязательный параметр) |
bdate | string bdate=27.01.1992 | День рождения должника в формате mm.dd.yyyy (необязательный параметр) |
format | integer format=1 | Тип формата возвращаемых данных. Возможные значения параметра: 1 – выводить результаты в группированном виде 2 – выводить негруппированный список исполнительных производств (значение по умолчанию) |
key | string key=67ac454f6a3fa85355aee5e41b6d154efc589aab | Ваш ключ доступа к API |
Возвращаемый документ (HTTP response) представляет собой структурированный документ JSON, содержащий информацию об исполнительных производствах (как действующих, так и завершенных) в отношении физического лица.
Поля возвращаемого документа
format=1 (группированные данные):
Имя | Тип | Описание |
---|---|---|
result | object | Информация об исполнительных производствах ФЛ |
Год | object | Год возбуждения исполнительного производства в формате YYYY (Поля объекта такие же, как и в результатах метода isps) |
format=2 (негруппированные данные):
Api бдип фссп россии что это
Об актуальных изменениях в КС узнаете, став участником программы, разработанной совместно с АО «Сбербанк-АСТ». Слушателям, успешно освоившим программу выдаются удостоверения установленного образца.
Программа разработана совместно с АО «Сбербанк-АСТ». Слушателям, успешно освоившим программу, выдаются удостоверения установленного образца.
Обзор документа
Описание интерфейса программирования приложений в информационно-телекоммуникационной сети интернет для доступа к общедоступным сведениям банка данных в исполнительном производстве ФССП России (утв. ООО «Драйв Диджитал» и Управлением информационных технологий Федеральной службы судебных приставов 30, 31 января 2018 г.)
Термины и сокращения
Термин/сокращение | Описание |
---|---|
API | Application Programming Interface, интерфейс программирования приложений |
БДИП | Банк данных в исполнительном производстве |
ИП | Исполнительное производство |
CURL | Служебная программа командной строки, позволяющая взаимодействовать с сервером по различным протоколам с синтаксисом URL |
JSON | Javascript Object Notation, основанный на синтаксисе Javascript формат обмена данными |
HTTPS | HyperText Transfer Protocol Secure, расширение протокола HTTP с поддержкой шифрования |
REST | Representational State Transfer, архитектурный стиль организации сетевого взаимодействия |
1. Основание для разработки
Публичный API доступа к банку данных исполнительных производств разработан во исполнение пункта 7.4 Порядка создания и ведения банка данных в исполнительном производстве Федеральной службы судебных приставов, утвержденного приказом Федеральной службы судебных приставов от 12 мая 2012 г. N 248 (в редакции приказа от 27.12.2017 N 676).
2. Назначение интерфейса программирования приложений
— Сведения об исполнительных производствах в отношении юридических лиц (по наименованию, региону, юридическому адресу);
— Сведения об исполнительных производствах в отношении физических лиц (по фамилии, имени и отчеству, дате рождения и региону);
— Сведения об исполнительном производстве (по его номеру).
3. Процедура регистрации
Для доступа к API требуется авторизация. Авторизация производится по ключу доступа, передаваемому в каждом запросе и получаемому пользователем API при регистрации.
Ссылка на форму регистрации пользователя API размещена на странице http://fssprus.ru/iss/ip. Форма защищена от автоматической регистрации.
После заполнения формы создается неактивированная учетная запись пользователя без возможности производить запросы, на указанный в форме адрес электронной почты отправляется ссылка для подтверждения адреса. При переходе по ссылке учетная запись пользователя активируется (пользователь получает право производить запросы к API), на адрес электронной почты высылается ключ доступа.
4. Общие сведения о работе API
Предоставляемый API доступа выполнен в архитектурном стиле REST, принимает HTTPS-запросы, возвращает результаты в формате JSON.
Адрес точки доступа к API: https://api-ip.fssprus.ru/api/v1.0/.
— требует авторизации пользователей;
— предоставляет возможность групповых запросов.
Авторизация подразумевает необходимость передавать в каждом запросе ключ доступа (токен), получаемый при регистрации. Подробнее процедура регистрации пользователя описана в разделе 3.
Асинхронность API означает, что в ответ на подачу запроса пользователю передается идентификатор, по которому пользователь отдельными методами должен будет определить статус выполнения запроса и получить ответ.
Групповые (пакетные) запросы запросы, дающие возможность указать одновременно несколько наборов значений параметров («подзапросов»). Устанавливается ограничение на количество подзапросов в групповом запросе.
5. Описание методов API
5.1. «Запрос на поиск сведений о физическом лице»
Параметр запроса | Описание параметра |
---|---|
token* | Ключ доступа к API, полученный при регистрации |
region* | Код региона отдела судебных приставов, ведущего ИП, в соответствии со справочником регионов ФССП России |
firstname* | Имя должника по исполнительному производству |
secondname | Отчество должника по исполнительному производству |
lastname* | Фамилия должника по исполнительному производству |
birthdate | Дата рождения должника в формате «дд.мм.гггг» |
CURL-пример запроса приводится в разделе 6.1.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/physical:
— Сообщение о недействительности ключа доступа;
— Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах с описаниями параметров такие параметры помечены звездочкой «*»);
— Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5 и 5.6.
5.2. «Запрос на поиск сведений о юридическом лице»
CURL-пример запроса приводится в разделе 6.2.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/legal:
— Сообщение о недействительности ключа доступа;
— Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах с описаниями параметров такие параметры помечены звездочкой «*»);
— Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5 и 5.6.
5.3. «Запрос на поиск сведений об исполнительном производстве»
CURL-пример запроса приводится в разделе 6.3.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/ip:
— Сообщение о недействительности ключа доступа;
— Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах с описаниями параметров такие параметры помечены звездочкой «*»);
— Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5 и 5.6.
5.4. «Групповой запрос на поиск информации в БДИП»
Групповой запрос подается HTTP-методом POST. Тело запроса содержит JSON-объект с двумя полями: token и request.
Значением token является ключ доступа к API, передавать его как GET-параметр при групповом запросе не следует.
Значением request является массив объектов, соответствующих отдельным запросам, каждый такой объект имеет два поля: request[].type и request[].params.
Пример тела группового запроса на поиск информации приводится ниже.
CURL-пример запроса приводится в разделе 6.4.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/group:
— Сообщение о недействительности ключа доступа;
— Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах с описаниями параметров такие параметры помечены звездочкой «*»);
— Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Значение response.task в дальнейшем используется в качестве параметра вызовов методов 5.5 и 5.6.
5.5. «Проверка статуса поданного запроса»
Параметр запроса | Описание параметра |
---|---|
token* | Ключ доступа к API, полученный при регистрации |
task* | Идентификатор отправленного запроса |
CURL-пример запроса приводится в разделе 6.5.
В штатном режиме функционирования API возможны следующие ответы:
— Сообщение об ошибке при обработке текущего запроса;
— Сообщение о статусе обработки прежде поданного запроса сведений БДИП.
В последнем случае ответ сервиса имеет вид как в примере ниже.
В приведенном ответе:
5.6. «Получение результатов поданного запроса»
Параметр запроса | Описание параметра |
---|---|
token* | Ключ доступа к API, полученный при регистрации |
task* | Идентификатор отправленного запроса |
CURL-пример запроса приводится в разделе 6.6.
В штатном режиме функционирования API возможны следующие ответы:
— Сообщение об ошибке при обработке текущего запроса;
— Сообщение, содержащее результаты обработки прежде поданного запроса сведений БДИП.
Для группового запроса ответ выглядит как в примере ниже.
Порядок результатов в response.result соответствует порядку запросов в групповом запросе (см. раздел 5.4).
Для единичных запросов (см. разделы 5.1-5.3) response.result содержит единственный элемент.
6. Примеры запросов
Дополнительные справочные материалы по использованию методов API размещены на официальном интернет-сайте ФССП России. Способ размещения этих материалов дает пользователю API возможность подавать к API тестовые запросы.
Ниже приводятся примеры запросов к методам API с помощью утилиты командной строки CURL. Во всех примерах ниже значение параметра token («yourapikey») следует заменить на полученный при регистрации ключ доступа.
6.1. «Запрос на поиск сведений о физическом лице»
6.2. «Запрос на поиск сведений о юридическом лице»
6.3. «Запрос на поиск сведений об исполнительном производстве»
6.4. «Групповой запрос на поиск информации в БДИП»
Приведено описание интерфейса программирования приложений в сети Интернет (API) для доступа к сведениям банка данных в исполнительном производстве ФССП России.
Возможно получение сведений об исполнительных производствах в отношении юрлиц (по наименованию, региону, юридическому адресу); физлиц (по фамилии, имени и отчеству, дате рождения и региону); об исполнительном производстве (по его номеру).
Закреплены процедуры регистрации и авторизации.