Открытые данные
Содержание:
- Примеры запросов
- 6.1. «Запрос на поиск сведений о физическом лице»
- 6.2. «Запрос на поиск сведений о юридическом лице»
- 6.3. «Запрос на поиск сведений об исполнительном производстве»
- 6.4. «Групповой запрос на поиск информации в БДИП
- 6.5. «Проверка статуса поданного запроса»
- 6.6. «Получение результатов поданного запроса»
- 7. Иные условия предоставления доступа к API
- Описание методов API
- Общие сведения о работе API
- Описание методов API
- Общие сведения о работе API
- Термины и сокращения
- Термины и сокращения
- АИС ФССП России — Автоматизированная информационная система Федеральной службы судебных приставов России
- Примеры запросов
- 6.1. «Запрос на поиск сведений о физическом лице»
- 6.2. «Запрос на поиск сведений о юридическом лице»
- 6.3. «Запрос на поиск сведений об исполнительном производстве»
- 6.4. «Групповой запрос на поиск информации в БДИП
- 6.5. «Проверка статуса поданного запроса»
- 6.6. «Получение результатов поданного запроса»
- 7. Иные условия предоставления доступа к API
Примеры запросов
Дополнительные справочные материалы по использованию методов API размещены на официальном интернет-сайте ФССП России. Способ
размещения этих материалов дает пользователю API возможность подавать к API тестовые запросы.
Ниже приводятся примеры запросов к методам API с помощью утилиты командной строки CURL. Во всех примерах ниже значение параметра
token («yourapikey») следует заменить на полученный при регистрации ключ доступа.
6.1. «Запрос на поиск сведений о физическом лице»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/physical \
--data-urlencode "region=66" \
--data-urlencode "lastname=Иванов" \
--data-urlencode "firstname=Иван" \
--data-urlencode "token=yourapikey"
6.2. «Запрос на поиск сведений о юридическом лице»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/legal \
--data-urlencode "region=66" \
--data-urlencode "name=Ромашка" \
--data-urlencode "token=yourapikey"
6.3. «Запрос на поиск сведений об исполнительном производстве»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/ip \
--data-urlencode "number=6860/12/61/66" \
--data-urlencode "token=yourapikey"
6.4. «Групповой запрос на поиск информации в БДИП
curl -X POST https://api-ip.fssp.gov.ru/api/v1.0/search/group \
-H "Content-Type: application/json" \
-d @- << EOF
{
"token": "yourapikey",
"request": [
{
"type": 1,
"params": {
"firstname": "Сергей",
"lastname": "Иванов",
"region": 66
}
},
{
"type": 2,
"params": {
"name": "Ромашка",
"region": 66
}
},
{
"type": 3,
"params": {
"number": "6860/12/61/66"
}
}
]
}
EOF
6.5. «Проверка статуса поданного запроса»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/status \
--data-urlencode "task=ADAB49B2-F435-49CC-80DF-55F2F57D3057" \
--data-urlencode "token=yourapikey"
6.6. «Получение результатов поданного запроса»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/result \
--data-urlencode "task=BDAB49B2-F435-49CC-80DF-55F2F57D3057" \
--data-urlencode "token=yourapikey"
7. Иные условия предоставления доступа к API
Максимальное число подзапросов в групповом запросе — 50 (если требуется отправить большее число, следует разбивать запрос
на несколько).
Максимальное число одиночных запросов в час — 100
Максимальное число одиночных запросов в сутки — 1000
Срок хранения результатов запроса (промежуток между обращениями к методам /search/ и методу /result) — 24 часа.
Контакты технической поддержки:
- Телефон: +7 (495) 870-95-96 (с 9:00 до 18:00).
- Электронная почта: admin@fssp.gov.ru.
Описание методов API
5.1. «Запрос на поиск сведений о физическом лице»
GET /search/physical
| Параметр запроса | Описание параметра |
|---|---|
|
token * |
Ключ доступа к API, полученный при регистрации |
| region * |
Код региона отдела судебных приставов, ведущего ИП, в соответствии со справочником регионов ФССП России |
|
firstname * |
Имя должника по исполнительному производству |
| secondname | Отчество должника по исполнительному производству |
|
lastname * |
Фамилия должника по исполнительному производству |
| birthdate | Дата рождения должника в формате «дд.мм.гггг» |
CURL-пример запроса приводится в разделе 6.1.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/physical:
- Сообщение о недействительности ключа доступа;
- Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах
с описаниями параметров такие параметры помечены звездочкой «*»); - Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Общие сведения о работе API
Предоставляемый API доступа выполнен в архитектурном стиле REST, принимает HTTPS-запросы, возвращает результаты в формате
JSON
Адрес точки доступа к API:
https://api-ip.fssp.gov.ru/api/v1.0/.
Предоставляемый API:
- требует авторизации пользователей;
- является асинхронным;
- предоставляет возможность групповых запросов.
Авторизация подразумевает необходимость передавать в каждом запросе ключ доступа (токен), получаемый при регистрации.
Подробнее процедура регистрации пользователя описана в разделе 3..
Асинхронность API означает, что в ответ на подачу запроса пользователю передается идентификатор, по которому пользователь
отдельными методами должен будет определить статус выполнения запроса и получить ответ.
Групповые (пакетные) запросы — запросы, дающие возможность указать одновременно несколько наборов значений параметров
(«подзапросов»). Устанавливается ограничение на количество подзапросов в групповом запросе.
Описание методов API
5.1. «Запрос на поиск сведений о физическом лице»
GET /search/physical
| Параметр запроса | Описание параметра |
|---|---|
|
token * |
Ключ доступа к API, полученный при регистрации |
| region * |
Код региона отдела судебных приставов, ведущего ИП, в соответствии со справочником регионов ФССП России |
|
firstname * |
Имя должника по исполнительному производству |
| secondname | Отчество должника по исполнительному производству |
|
lastname * |
Фамилия должника по исполнительному производству |
| birthdate | Дата рождения должника в формате «дд.мм.гггг» |
CURL-пример запроса приводится в разделе 6.1.
В штатном режиме функционирования API возможны следующие ответы на запрос, выполненный методом /search/physical:
- Сообщение о недействительности ключа доступа;
- Сообщение об ошибках форматно-логического контроля (например, не указано значение обязательного параметра метода; в таблицах
с описаниями параметров такие параметры помечены звездочкой «*»); - Сгенерированный API идентификатор запроса.
Примеры ответов для трех перечисленных случаев приведены ниже.
Общие сведения о работе API
Предоставляемый API доступа выполнен в архитектурном стиле REST, принимает HTTPS-запросы, возвращает результаты в формате
JSON
Адрес точки доступа к API:
https://api-ip.fssp.gov.ru/api/v1.0/.
Предоставляемый API:
- требует авторизации пользователей;
- является асинхронным;
- предоставляет возможность групповых запросов.
Авторизация подразумевает необходимость передавать в каждом запросе ключ доступа (токен), получаемый при регистрации.
Подробнее процедура регистрации пользователя описана в разделе 3..
Асинхронность API означает, что в ответ на подачу запроса пользователю передается идентификатор, по которому пользователь
отдельными методами должен будет определить статус выполнения запроса и получить ответ.
Групповые (пакетные) запросы — запросы, дающие возможность указать одновременно несколько наборов значений параметров
(«подзапросов»). Устанавливается ограничение на количество подзапросов в групповом запросе.
Термины и сокращения
| Термин / сокращение | Описание |
| API | Application Programming Interface,интерфейс программирования приложений |
| БДИП | Банк данных в исполнительном производстве |
| ИП | Исполнительное производство |
| CURL | Служебная программа командной строки, позволяющая взаимодействовать с сервером по различным протоколам с синтаксисом URL |
| JSON | Javascript Object Notation, основанный на синтаксисе Javascript формат обмена данными |
| HTTPS | HyperText Transfer Protocol Secure, расширение протокола HTTP с поддержкой шифрования |
| REST | Representational State Transfer, архитектурный стиль организации сетевого взаимодействия |
Термины и сокращения
| Термин / сокращение | Описание |
| API | Application Programming Interface,интерфейс программирования приложений |
| БДИП | Банк данных в исполнительном производстве |
| ИП | Исполнительное производство |
| CURL | Служебная программа командной строки, позволяющая взаимодействовать с сервером по различным протоколам с синтаксисом URL |
| JSON | Javascript Object Notation, основанный на синтаксисе Javascript формат обмена данными |
| HTTPS | HyperText Transfer Protocol Secure, расширение протокола HTTP с поддержкой шифрования |
| REST | Representational State Transfer, архитектурный стиль организации сетевого взаимодействия |
АИС ФССП России — Автоматизированная информационная система Федеральной службы судебных приставов России
АИС ФССП России является комплексной территориально-распределённой информационной системой, разработанной на основе свободного программного обеспечения, и в настоящее время функционирует в более чем 2 800 отделах судебных приставов. На территориальном и федеральном уровне внедрены центральные базы данных, на основе которых выполняется контроль за ходом ведомственных процессов ФССП России.
В центральном аппарате ФССП России развернуты подсистемы, обеспечивающие документооборот в части ведения нормативно-справочной информации, обеспечения межведомственного взаимодействия, работы внутреннего портала.
В федеральной центральной базе данных имеются сведения о более чем 198 миллионах исполнительных производств и более чем 5,2 млрд карточек документов.
Ежедневно системой АИС ФССП России пользуются более 80 000 сотрудников и более 100 контрагентов (администраторы доходов бюджета, ОГВ субъектов РФ, кредитные организации, операторы связи и др.).
Центральный сервер межведомственного электронного взаимодействия ФССП России обеспечивает в периоды пиковой нагрузки выполнение более 130 млн операций в сутки.
АИС ФССП России в части программного обеспечения имеет высокую степень технологической независимости с заданным уровнем обеспечения безопасности:
- операционная система – GosLinux;
- система программирования – GCC, OpenJDK, IntelliJIDEA;
- СУБД – Ред База Данных 2.5;
- сервер приложений – Ред Платформа;
- комплекс библиотек программ – адаптированные библиотеки программ с открытым кодом.
АИС ФССП России включает в себя следующие компоненты:
- Подсистема централизованного ведения и распространения нормативно-справочной информации (Подсистема НСИ) АИС ФССП России;
- Подсистема технологического мониторинга и администрирования (Подсистема ТМА) АИС ФССП России;
- Подсистема гарантированной доставки (Подсистема ГД) АИС ФССП России;
- Программный комплекс отдела судебных приставов (ПК ОСП) АИС ФССП России;
- Подсистема ведомственного статистического учета (Подсистема ВС) АИС ФССП России;
- Подсистема оперативного мониторинга и анализа информации (Подсистема ВА) АИС ФССП России на базе центральной и региональных
баз данных; - Подсистема межведомственного взаимодействия (Подсистема МВВ) АИС ФССП России;
- Ведомственная система электронной почты АИС ФССП России;
- Подсистема электронного документооборота (Подсистема ЭД) АИС ФССП России;
- Ведомственный служебный портал АИС ФССП России.
Подсистема ГД, Подсистема ТМА, ПК ОСП, Подсистема ВС, Подсистема ВА, Подсистема МВВ, Подсистема НСИ, Подсистема ЭД, Ведомственный служебный портал являются различными конфигурациями единой технологической платформы подсистем АИС ФССП России.
Информация о регистрации ФГИС:
Реестровый номер: 0133
Номер и дата выдачи электронного паспорта: ФС-77110133 от 08.09.2011
Ссылка на реестр: http://rkn.gov.ru/it/register/?id=101853
Примеры запросов
Дополнительные справочные материалы по использованию методов API размещены на официальном интернет-сайте ФССП России. Способ
размещения этих материалов дает пользователю API возможность подавать к API тестовые запросы.
Ниже приводятся примеры запросов к методам API с помощью утилиты командной строки CURL. Во всех примерах ниже значение параметра
token («yourapikey») следует заменить на полученный при регистрации ключ доступа.
6.1. «Запрос на поиск сведений о физическом лице»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/physical \
--data-urlencode "region=66" \
--data-urlencode "lastname=Иванов" \
--data-urlencode "firstname=Иван" \
--data-urlencode "token=yourapikey"
6.2. «Запрос на поиск сведений о юридическом лице»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/legal \
--data-urlencode "region=66" \
--data-urlencode "name=Ромашка" \
--data-urlencode "token=yourapikey"
6.3. «Запрос на поиск сведений об исполнительном производстве»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/search/ip \
--data-urlencode "number=6860/12/61/66" \
--data-urlencode "token=yourapikey"
6.4. «Групповой запрос на поиск информации в БДИП
curl -X POST https://api-ip.fssp.gov.ru/api/v1.0/search/group \
-H "Content-Type: application/json" \
-d @- << EOF
{
"token": "yourapikey",
"request": [
{
"type": 1,
"params": {
"firstname": "Сергей",
"lastname": "Иванов",
"region": 66
}
},
{
"type": 2,
"params": {
"name": "Ромашка",
"region": 66
}
},
{
"type": 3,
"params": {
"number": "6860/12/61/66"
}
}
]
}
EOF
6.5. «Проверка статуса поданного запроса»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/status \
--data-urlencode "task=ADAB49B2-F435-49CC-80DF-55F2F57D3057" \
--data-urlencode "token=yourapikey"
6.6. «Получение результатов поданного запроса»
curl -G https://api-ip.fssp.gov.ru/api/v1.0/result \
--data-urlencode "task=BDAB49B2-F435-49CC-80DF-55F2F57D3057" \
--data-urlencode "token=yourapikey"
7. Иные условия предоставления доступа к API
Максимальное число подзапросов в групповом запросе — 50 (если требуется отправить большее число, следует разбивать запрос
на несколько).
Максимальное число одиночных запросов в час — 100
Максимальное число одиночных запросов в сутки — 1000
Срок хранения результатов запроса (промежуток между обращениями к методам /search/ и методу /result) — 24 часа.
Контакты технической поддержки:
- Телефон: +7 (495) 870-95-96 (с 9:00 до 18:00).
- Электронная почта: admin@fssp.gov.ru.
