API предоставляет собой интерфейс для информационного взаимодействия с разделом – «Официальное опубликование» (publication.pravo.gov.ru), «Официального интернет-портала правовой информации» (www.pravo.gov.ru). С предлагаемым интерфейсом могут взаимодействовать как веб-сервисы, так и приложения.
Взаимодействие с API производится только в режиме чтения. Методов для записи данных в систему не предоставляется.
Запрос списка блоков публикации и под-блоков
- позволяет получить необходимый список Блоков публикации (БП), включая вложенные подблоки.
URL запроса на получение списка блоков публикации: …/api/PublicBlocks/
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ |
parent | Код блока, у которого надо получить все дочерние блоки |
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа содержится структурированный список записей, соответствующих Блокам публикации (БП) и относящимся к ним подблокам (пока используется один уровень вложенности).
Каждая запись о БП (и подблоке) содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ | |||||||||
"id" | GUID Блока публикации (БП) | |||||||||
"shortName" | Краткое имя | |||||||||
"name" | Полное наименование БП | |||||||||
"menuName" | Наименование БП в меню | |||||||||
"code" | Код Блока публикации | |||||||||
"description" | Описание | |||||||||
"weight" | Вес для сортировки | |||||||||
"isBlocked" | Признак временной блокировки Блока публикации | |||||||||
"parentId" | GUID родительского Блока публикации (для подблока) | |||||||||
"hasChildren" | Признак наличия дочерних подблоков | |||||||||
"isAgenciesOfStateAuthorities" | Признак: БП соответствует органу исполнительной власти РФ | |||||||||
"imageId" | GUID картинки с символом БП | |||||||||
"categories" | Категории БП, уточняющий вид ФОИВ - заполняется в частности для БП «ОГВ Субъектов РФ» (subjects). | |||||||||
|
| |||||||||
"section" | Подраздел БП, уточняющий вид ФОИВ - заполняется только для БП «ФОИВ и ФГО РФ» (federal_authorities). | |||||||||
|
| |||||||||
"parent" | - (Вероятно, устаревший вариант "parentId") | |||||||||
"items" | Список Подблоков публикации (дочерних БП по отношению к родительскому БП). | |||||||||
Набор полей записей по подблоку (в объекте "items") аналогичен таковому в БП | ||||||||||
Пример запроса:
…/api/PublicBlocks?parent=assembly – запрос подблоков Блока "Федеральное Собрание Российской Федерации"
Пример содержания ответа:
[
{
"shortName": "Федеральное Собрание Российской Федерации",
"menuName": "Федеральное Собрание Российской Федерации",
"code": "assembly",
"description": "Акты палат Федерального Собрания, принятые по вопросам, отнесенным к ведению палат частью 1 статьи 102 и частью 1 статьи 103 Конституции Российской Федерации",
"weight": 998,
"isBlocked": false,
"parent": null,
"section": null,
"parentId": null,
"hasChildren": true,
"isAgenciesOfStateAuthorities": false,
"items": [
{
"shortName": "Государственная Дума ФС РФ",
"menuName": "Государственная Дума ФС РФ",
"code": "council_2",
"description": "Постановления Государственной Думы, принятые по вопросам, \nотнесенным к ведению палаты частью 1 статьи 103 \nКонституции Российской Федерации",
"weight": 998,
"isBlocked": false,
"parent": null,
"section": null,
"parentId": "a30c9c82-4a21-48ab-a41d-d1891a10962c",
"hasChildren": false,
"isAgenciesOfStateAuthorities": false,
"items": [],
"imageId": "288b4ab3-27c4-49ae-a771-aab50a887b9a",
"categories": null,
"name": "Государственная Дума",
"id": "0dbe1bc1-0e40-446a-a3ba-1ccabe18ca5e"
}
]
Запрос списка категорий принявших органов
- позволяет получить необходимый список Категорий принявших органов.
URL запроса на получение списка блоков публикации: …/api/Categories
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ | ОБЯЗАТЕЛЬНЫЙ |
block | Код блока публикации, для которого необходимо отобразить Категории | Да |
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа содержится структурированный список записей, соответствующих Категориям. Каждая запись о Категории содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ |
"id" | GUID Категории |
"name" | Полное наименование |
"code" | Код Категории |
Пример запроса:
…/api/Categories?block=government – запрос Категорий принявших органов по Блоку публикации "Правительство Российской Федерации".
Пример содержания ответа:
[
{
"code": "iogv",
"name": "Органы исполнительной власти",
"id": "aeeef2f5-6bb7-4b4a-a102-88950eab4858"
}
]
Запрос списка принявших органов
- позволяет получить необходимый список Принявших органов (ПО).
URL запроса на получение списка блоков публикации: …/api/SignatoryAuthorities
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ |
block | Код блока публикации |
сategory | Код Категории ПО |
Все параметры являются необязательными.
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа содержится структурированный список записей, соответствующих Принявшим органам (ПО). Каждая запись о ПО содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ |
"id" | GUID Принявшего органа |
"name" | Полное наименование |
"weight " | Вес для сортировки |
Пример запроса:
…/api/SignatoryAuthorities?block=government – запрос принявших органов по Блоку публикации "Правительство Российской Федерации"
Пример содержания ответа:
[
{
"weight": 93000,
"name": "Правительство Российской Федерации",
"id": "8005d8c9-4b6d-48d3-861a-2a37e69fccb3"
}
]
Запрос списка видов документов
- позволяет получить необходимый список Видов документов (ВД).
URL запроса на получение списка блоков публикации: …/api/DocumentTypes
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ |
block | Код блока публикации |
сategory | Код Категории ПО |
SignatoryAuthorityId | GUID Принявшего органа |
Все параметры являются необязательными.
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа содержится структурированный список записей, соответствующих Видам документов. Каждая запись о ПО содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ |
"id" | GUID вида документа |
"name" | Полное наименование |
"weight " | Вес для сортировки |
Пример запроса:
…/api/DocumentTypes?SignatoryAuthorityId=8005d8c9-4b6d-48d3-861a-2a37e69fccb3 – запрос Видов документов по Принявшему органу "Правительство Российской Федерации "
Пример содержания ответа:
[
{
"weight": 91,
"addition": null,
"name": "Договор",
"id": "63c6ff4f-ed74-45b3-86e2-8a76b75d674d"
}
]
Запрос списка документов (поиск документов)
Основным запросом к API является поиск по документам (нормативно-правовым актам - НПА), который возвращает список найденных документов. Широкий набор параметров запроса позволяет фильтровать коллекцию запрашиваемых документов по различным критериям. Некоторые из этих параметров являются идентификаторами объектов из справочников, приведенных выше (Блок публикации, Категория принимающего органа, Принимающий орган, Вид документа).
URL запроса на получение списка НПА: …/api/Documents
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ |
Block | Код блока публикации |
Category | Код Категории принимающего органа |
SignatoryAuthorityId | GUID Принявшего органа |
DocumentTypes | GUID вида документа (можно использовать несколько значений) |
EoNumber | Номер электронного опубликования |
PeriodType | Фиксированный временной период выборки данных по дате опубликования: «daily» - выборка НПА, опубликованных Сегодня «weekly» - выборка за текущую Неделю (с Пн по Вс) «monthly» - выборка за текущий Месяц «day» - выборка за определенный день, который указывается в параметре «Date» |
Date | Дата опубликования документов, если параметр PeriodType указан как «Day» |
DocumentDateFrom | Дата подписания документа – начало периода поиска |
DocumentDateTo | Дата подписания документа – конец периода поиска |
Name | Составное название документа, включающее вид, дату и номер НПА, а также название принимающего органа |
NumberSearchType | Режим поиска по номеру НПА, возможны следующие значения: 0 – точно 1 – начинается с 2 – заканчивается на 3 – содержит |
Number | Номер документа (НПА) – режим поиска, в соответствии с параметром «NumberSearchType» |
JdRegNumber | Номер регистрации в Минюсте |
JdRegDateFrom | Дата регистрации в Минюсте – начало периода поиска |
JdRegDateTo | Дата регистрации в Минюсте– конец периода поиска |
PublishDateFrom | Дата публикации НПА – начало периода поиска |
PublishDateTo | Дата публикации НПА – конец периода поиска |
DocumentText | Текст документа |
PageSize | Количество возвращаемых записей на страницу, возможны следующие значения: 10, 30, 100, 200 |
Index | Номер страницы результатов, которую необходимо отобразить. |
SortedBy | Параметр, по которому должна выполняться сортировка: 0 – Дата подписания 1 – Вид документа 2 – Принявший орган 3 – Номер документа 4 – Дата опубликования 5 – Номер опубликования |
SortDestination | Направление сортировки:
|
Все параметры являются необязательными.
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные – список документов, соответствующий критериям (параметрам) запроса.
В JSON файле ответа содержится структурированный список записей, соответствующих выбранным документам. Данные о документах будут содержать следующий набор полей:
ПОЛЕ JSON ФАЙЛА | ОПИСАНИЕ | |||||||||||||||||||||||||||
"items" | Список документов - представлен как набор нескольких вложенных объектов (записей): | |||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||
"itemsTotalCount" | Всего элементов (документов) в итоговой выборке | |||||||||||||||||||||||||||
"itemsPerPage" | Количество элементов выводимых на одной странице списка | |||||||||||||||||||||||||||
"pagesTotalCount" | Общее кол-во страниц при постраничном отображении списка документов | |||||||||||||||||||||||||||
"currentPage" | Номер текущей отображаемой страницы списка документов | |||||||||||||||||||||||||||
Пример запроса:
…/api/Documents?DocumentTypes=2dddb344-d3e2-4785-a899-7aa12bd47b6f
&NumberSearchType=0&Number=3 – запрос документов, вида «Приказ» и номер которого точно равер «3».
Пример содержания ответа:
{
"items": [
{
"eoNumber": "1601202011170002",
"hasSvg": false,
"zipFileLength": 0,
"publishDateShort": "2020-11-17T00:00:00",
"complexName": "Приказ Агентства инвестиционного развития Республики Татарстан от 17.11.2020 № 3",
"pagesCount": 6,
"pdfFileLength": 274714,
"jdRegNumber": null,
"jdRegDate": null,
"title": "Приказ Агентства инвестиционного развития Республики Татарстан от 17.11.2020 № 3",
"viewDate": "17.11.2020",
"id": "5c2ed551-bd4c-4c0e-88cf-70be617c16d6"
}
],
"itemsTotalCount": 1,
"itemsPerPage": 30,
"currentPage": 1,
"pagesTotalCount": 1
}
Запрос параметров отдельного документа
- позволяет получить расширенный набор параметров документа по номеру его электронного опубликования.
URL запроса на получение списка блоков публикации: …/api/Document
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ | ОБЯЗАТЕЛЬНЫЙ |
eoNumber | Номер электронного опубликования | Да |
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа будет содержаться запись, соответствующая запрошенному документу, которая содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ | |||||||||
"id" | GUID документа | |||||||||
"eoNumber" | Номер электронного опубликования | |||||||||
"publishDateShort" | Дата публикации в формате ISO 8601 | |||||||||
"viewDate" | Дата публикации в формате DD.MM.YYYY | |||||||||
"description" | Общее описание | |||||||||
"title" | Заголовок документа | |||||||||
"htmlTitle" | Заголовок документа в формате HTML | |||||||||
"twitterTitle" | Заголовок документа для Twitter | |||||||||
"complexName" | Полное составное название документа, включающее Вид, Дату и Номер документа, Принявший орган | |||||||||
"jdRegNumber" | Номер регистрации в Минюсте | |||||||||
"jdRegDate" | Дата регистрации в Минюсте | |||||||||
"pagesTotalCount" | Общее кол-во страниц при постраничном отображении многостраничного документа | |||||||||
"currentPage" | Номер текущей отображаемой страницы многостраничного документа | |||||||||
"itemsPerPage" | Кол-во страниц многостраничного документа, отображаемых на одной странице. | |||||||||
"pagesCount" | Количество страниц в PDF файле документа | |||||||||
"pdfFileLength" | Размер в байтах PDF файла документа | |||||||||
"zipFileLength" | Размер в байтах ZIP файла с приложениями, если таковой имеется | |||||||||
"hasLargeFiles" | Признак: в PDF файле документа есть страницы формата А3 и крупнее | |||||||||
"hasIpsUrl" | Признак наличия документа в ИПС Законодательство России | |||||||||
"ipsUrl" | Ссылка на карточку документа в ИПС Законодательство России | |||||||||
"hasApiDumaUrl" | Признак наличия документа на сайте Гос.Думы | |||||||||
"apiDumaUrl" | Ссылка на карточку документа на сайте Гос.Думы | |||||||||
"textLink" | Ссылка на текст документа, если текст документа доступен | |||||||||
"hasSvg" | Признак: у документа есть прикрепленные SVG файлы | |||||||||
"foivUrl" | Ссылка на документ на Федеральном портале проектов нормативных правовых актов (regulation.gov.ru) | |||||||||
"isTextExist" | Признак наличия документа в текстовом формате | |||||||||
"isEditExist" | Признак наличия у документа редакций | |||||||||
"hasFoivUrl" | Признак наличия документа на Федеральном портале проектов нормативных правовых актов (regulation.gov.ru) | |||||||||
"hasSigFile" | Признак наличия у документа файла ЭП | |||||||||
"docLinks" | Ссылки на файлы документа | |||||||||
"documentImagesCount" | Количество картинок - иллюстраций в документе | |||||||||
"imagesList" | Список отображаемых картинок-иллюстраций. | |||||||||
|
| |||||||||
Пример запроса:
…/api/Document?eoNumber=2600202104190001– запрос параметров документа, опубликованного с эл.номером «2600202104190001»
Пример содержания ответа:
{
"imagesList": [
{
"pageNumber": 1,
"hasLarge": false,
"hasSvg": true
}
],
"itemsPerPage": 1,
"htmlTitle": "Распоряжение Губернатора Ставропольского края от 16.04.2021 № 16-1 ∙ Официальное опубликование правовых актов ∙ Официальный интернет-портал правовой информации",
"description": "Распоряжение Губернатора Ставропольского края от 16.04.2021 № 16-1",
"documentImagesCount": 1,
"currentPage": 1,
"pagesTotalCount": 1,
"hasLargeFiles": false,
"hasIpsUrl": false,
"ipsUrl": null,
"apiDumaUrl": null,
"isTextExist": false,
"isEditExist": false,
"textLink": null,
"twitterTitle": "Распоряжение Губернатора Ставропольского края от 16.04.2021 № 16-1",
"hasApiDumaUrl": false,
"eoNumber": "2600202104190001",
"hasSvg": false,
"zipFileLength": 0,
"publishDateShort": "2021-04-19T00:00:00",
"complexName": "Распоряжение Губернатора Ставропольского края от 16.04.2021 № 16-1",
"pagesCount": 1,
"pdfFileLength": 28238,
"jdRegNumber": null,
"jdRegDate": null,
"title": "Распоряжение Губернатора Ставропольского края от 16.04.2021 № 16-1",
"viewDate": "19.04.2021",
"id": "9f1fbce8-4882-4c55-a14f-14e45e1138ec"
}
Запрос статистики опубликования документов
- позволяет получить данные о количестве опубликованных на Портале документов в разрезе Блоков публикации за последний выбранный отрезок времени.
URL запроса на получение списка блоков публикации: …/api/BlockStatistic
Параметры запроса:
ПАРАМЕТР | ОПИСАНИЕ | ОБЯЗАТЕЛЬНЫЙ |
period | Временной период за который рассчитываются данные. | Да |
Формат ответа:
В ответ на отправленный запрос API вернет текст (файл) в формате JSON, который содержит запрашиваемые данные.
В JSON файле ответа содержится структурированный список записей, соответствующих Принявшим органам (ПО). Каждая запись о ПО содержит следующий набор полей:
ПОЛЕ JSON | ОПИСАНИЕ |
"block" | Код блока публикации |
"documentsCount" | Количество опубликованных на Портале документов |
Пример запроса:
…/api/BlockStatistics/%20daily – запрос статистики опубликованных документов за последний день.
Пример содержания ответа:
[
{
"block": "president",
"documentsCount": 4
},
{
"block": "assembly",
"documentsCount": 6
},
{
"block": "government",
"documentsCount": 1
},
{
"block": "federal_authorities",
"documentsCount": 114
},
{
"block": "court",
"documentsCount": 2
},
{
"block": "subjects",
"documentsCount": 167
},
{
"block": "international",
"documentsCount": 1
},
{
"block": "un_securitycouncil",
"documentsCount": 1
}
]