Войти
Назад

Настройки подключения услуги к API ЕПГУ

link
Скопировать прямую ссылку на статью

Оглавление


Общая информация

Настройки подключения к API ЕПГУ предназначены для того, чтобы услугу можно было вывести в API ЕПГУ и Внешние ИС могли отправлять заявления в ведомства от имени Пользователя

В этом случае заполнение формы услуги и формирование необходимых файлов в соответствии с требованиями Видов Сведения реализуется на стороне Внешней ИС

При этом процессинг заявления осуществляется уже на стороне ЕПГУ, как и обработка ответов Ведомства

При отправке заявления через API ЕПГУ Пользователь, с чьими правами выполняется отправка, видит информацию о заявлении также, как если бы он подавал заявление с формы услуги ЕПГУ

В текущей Версии API ЕПГУ не поддерживается работа с 14, 15, 19 статусами. Если услуга предполагает их наличие, то, если Ведомство их направляет, выполнять их обработку Пользователем возможно только на ЕПГУ


Этапы настройки

  1. Настройка параметров ИС для отправки заявлений через API ЕПГУ
  2. Настройка услуги в ВКУ для подключения к API ЕПГУ
  3. Проведение тестирования
  4. Вывод услугу в продуктивный контур

Этап 1. Настройка параметров ИС для отправки заявлений через API ЕПГУ

Для того, чтобы Внешняя ИС могла отправлять заявления по услуге, владельцы ИС должны выполнить мероприятия в соответствии с регламентом, описанным на странице

В случае, если услуга опубликована в API ЕПГУ при выполнении настроек в ВКУ, но Внешняя ИС не провела подключение в соответствии с регламентом, она не сможет отправлять заявления в ведомство от имени пользователя

Для этого в тестовой среде необходимо выполнить следующие действия:

  • зарегистрировать тестовые учётные записи руководителя организации и сотрудников, которые будут действовать от её лица. Подробнее в Регламенте, п. 3.1, шаг 1
  • запросить тестовые сертификаты усиленной квалифицированной электронной подписи (УКЭП) в «Федеральном ситуационном центре электронного правительства» (далее — Ситуационный центр). Подробнее в Регламенте, п. 4.2
  • зарегистрировать тестовые учётные записи организации вендора и организации потребителя, опираясь на Руководство пользователя ЕСИА, пп. 3.2, 3.3
  • присоединить к организации потребителю сотрудников, которые будут действовать от её лица, опираясь на Руководство пользователя ЕСИА, п. 3.5.1
  • зарегистрировать тестовую ИС организации вендора, опираясь на Руководство пользователя технологического портала ЕСИА, п. 3.1
  • подать заявку в СЦ с просьбой настроить доступ тестовой ИС к конкретной услуге. Подробнее в Регламенте, пп. 4.3.1, 4.3.2
  • заполнить и отправить анкету для создания полномочий для выбранной ИС для работы в тестовой среде
  • как вендор передать полномочия организации потребителю, опираясь на Руководство пользователя для организации вендора по формированию API Key и получению маркера доступа
  • как организация потребитель выдать сотрудникам полномочия для работы в ИС. Подробнее в Регламенте, п. 3.2, шаг 8

Этап 2. Настройка услуги в ВКУ для подключения к API ЕПГУ

Для того, чтобы опубликовать услугу в API ЕПГУ и Внешние ИС могли подключиться к ней и отправлять заявления, необходимо:

  1. Выполнить в ВКУ необходимые настройки услуги в разделе «Настройки подключения к API ЕПГУ»
  2. Для использования Внешними ИС подготовить спецификацию услуги в текстовом документе в соответствии с инструкцией для дальнейшей публикации в разделе «Технические спецификации» страницы «API Госуслуг»

    3. Рисунок1.png

  3. Выполнить публикацию услуги в соответствии с регламентом

Настройки подключения к API ЕПГУ находятся в разделе «Настройки подключения к API ЕПГУ» вкладки «Настройки услуги»

Рисунок2.png

Описание раздела "Настройки подключение к API ЕПГУ"

Рисунок3.png

№

Поле

Описание

1

Подключить услугу к API ЕПГУ

Чекбокс включает или отключает возможность отправлять заявления через API ЕПГУ

Данные услуги

2

Источник информации о пользователе

Обязательное поле, описывающее регулярным выражением мнемонику xml-файла, в котором должна передаваться информация о пользователе от Внешней ИС

Обычно это файл req*.xml, который всегда формируется при прохождении услуги

3

Бизнес-данные для отправки в ведомство

Обязательное поле, описывающее регулярным выражение мнемонику xml-файла, в котором должна передаваться информация формирования СМЭВ3-сообщения и отправки в ведомство

Обычно это файл attach*.xml, который может формироваться при прохождении услуги. Если такого файла на услуге не формируется, то можно указать любой файл, который должна прислать Внешняя ИС с информацией для заполнения тела СМЭВ3-сообщения

4

Прикладывать файл с бизнес-данными к СМЭВ3-сообщению

Флаг отмечается, если файл, указанный в поле «Бизнес-данные для отправки в ведомство» и полученный от Внешней ИС, должен быть отправлен в Ведомство как файл, приложенный к СМЭВ3-сообщению

Если флаг не отмечен, то данные из поля «Бизнес-данные для отправки в ведомство» только добавляются в СМЭВ3-сообщение без добавления самого файла

5

Проверять наличие файлов-подписи для всех файлов

Если флаг отмечен, то после получения файлов от Внешней ИС выполняется проверка наличие файлов-подписи ко всем файлом пакета. То есть должна всегда существовать пара файлов: <имя файла> - <имя файла>.sig

Например, для файла req.xml, должен быть файл req.xml.sig

Если флаг не отмечен, проверка не будет осуществляться

6

Проверять подпись всех файлов с помощью сервиса ГУЦ

Если флаг отмечен, то для каждого файла будет выполняться проверка файла подписи в ФГИС ГУЦ

Если флаг не отмечен, то проверка подписи выполняться не будет

Рисунок4.png

№

Поле

Описание

1

Обязательные файлы в заявлении

Указывается список регулярных выражений, в которых можно указать состав файлов и их наименования, которые должны отправляться в ведомство вместе со СМЭВ3-сообщением

Если в списке файлов, которые приложила Внешняя ИС, отсутствуют файлы, которые попадают хотя бы под одну из масок, указанных в данном списке, заявление не будет создано и отправлено в ведомство

2

Другие файлы не должны передаваться в ведомство

Если флаг включен, то никакие другие файлы, кроме тех, которые перечислены в поле «Обязательные файлы в заявлении» не могут быть отправлены в ведомство. В этом случае заявление не будет создано и отправлено в ведомство

Рисунок5.png

№

Поле

Описание

1

Игнорировать требования к обязательным файлам

Явно указываются файлы, которые можно исключить из требований к обязательным файлам

Например, данная ситуация возможна в случае, если в рамках обмена с ведомством требуется, чтобы отправлять можно было только файлы *.pdf, но при этом также формируются файлы req.xml и attach.xml, которые также надо принимать. В этом случае можно указать ограничения возможность отправлять только файлы *.pdf, а файлы req.xml и attach.xml исключить из проверок на обязательность

Рисунок6.png

№

Поле

Описание

1

Файлы заявления, которые запрещено передавать в ведомство

Указывается список регулярных выражений, в которых можно указать состав файлов и их наименования, которые не должны отправляться в ведомство вместе со СМЭВ3-сообщением

Если в списке файлов, которые приложила Внешняя ИС, есть хотя бы один файл, который попадает хотя бы под одну из масок, указанных в данном списке, заявление не будет создано и отправлено в ведомство

Рисунок7.png

№

Поле

Описание

1

Исключить из запрещенных для передачи файлов

Явно указываются файлы, которые можно исключить из требований к запрещённым файлам

Например, данная ситуация возможна в случае, если в рамках обмена с ведомством требуется, чтобы файлы *.xml не отправлялись в ведомство, но при этом также формируются файлы req.xml и attach.xml, которые также надо принимать

Рисунок8.png

№

Поле

Описание

1

Включить проверку множественных подписей файлов

Если в рамках услуги выполняется отправка в ведомство файлов, подписанные несколькими лицами (например, договор) с помощью этой настройки можно включить проверку подписи перед отправкой файлов в ведомство

2

Название XML-файла конфигурации соответствия файлов и подписей

В данном поле указывается имя XML-файла, которое должно формироваться на стороне Внешней ИС, в котором указывается соответствие файлов и подписей, которые соответствуют данному файлу

3

Передавать подписи в ведомство с заявлением

Флаг, который определяет, нужно ли передавать файлы подписи в ведомство или надо только проверить подпись

Рисунок9.png

№

Поле

Описание

1

Полномочия пользователей для подачи заявлений по услуге

Указывается список полномочий, с которыми пользователь может подавать заявление в ведомство при отправке заявлений из Внешней ИС

Данная проверка является дополнительной и позволяет не создавать заявление на ЕПГУ

Если данное ограничение в настройках API ЕПГУ не будет указано и заявление отправляется от имени пользователя, который не имеет права подавать заявление по данной услуге — заявление будет создано, но будет переведено в ошибочный статус «Ошибка отправки в ведомство»

Данная настройка позволяет избежать формирование ошибочных заявлений

Рисунок10.png

№

Поле

Описание

Настройки получения данных пользователя из XML

Данной настройкой можно определить ограничение, что пользователь отправляет заявление за себя. Проверка может осуществляться по СНИЛС, Номеру паспорта, ИНН организации и прочее

Задается список параметров, по которым выполняется сравнение данных пользователя, от имени которого Внешняя ИС выполняет отправку заявление в ведомство, и значений из req.xml (поле «Источник информации о пользователе»)

1 Путь до значения в xml для пользователя

Принимает одно из значений:

  • Физическое лицо
  • Юридическое лицо
2 Поле в XML

Может принимать одно из значений:

  • Номер заявления
  • Имя пользователя
  • Фамилия пользователя
  • Отчество пользователя
  • СНИЛС пользователя
  • Серия паспорта РФ
  • Номер паспорта РФ
  • Полное название организации
  • ИНН организации
  • ОГРН организации
3 Путь до значения в xml для пользователя Указывается путь до тега в xml

API_Рисунок11.png

№

Поле

Описание

Публикация услуги в отраслевом личном кабинете

Набор полей блока формирует информацию, которая не отображается непосредственно в интерфейсе отраслевого личного кабинета, но используется для осуществления поиска нужной услуги и дальнейшей инициации подключения услуги к сторонней системе. Поля являются обязательными для заполнения

1 Наименование услуги по спецификации

Официальное наименование услуги, зафиксированное в утверждённой МФЦ спецификации. Это название будет использовано при публикации спецификации услуги на отраслевом портале

2 Описание услуги для ОЛК API

Текстовое описание услуги, предназначенное для отображения в отраслевом личном кабинете. В поле необходимо описать услугу в свободной форме с акцентом на её функциональное назначение, ключевые возможности и сценарии использования


Этап 3. Проведение тестирования

После публикации услуги в API ЕПГУ и настройки прав на отправку заявлений по услуге из Внешней ИС необходимо провести тестирование

Для этого может быть использован программный продукт Postman или его аналог

В рамках данного тестирования необходимо убедиться, что взаимодействие с API ЕПГУ проходит успешно в части вызова соответствующих REST-методов (см. Спецификацию API ЕПГУ, пп. 2-5):

  • резервирование номера заявления
  • загрузка и отправка заявления после резервирования номера
  • загрузка и отправка заявления одним запросом
  • отмена заявления (для услуг, предполагающих возможность такой отмены)

Этап 4. Вывод услуги в продуктивный контур

После успешного тестирования необходимо провести заключительные мероприятия по выводу услуги в продуктивную среду ЕПГУ:

  1. Направить в СЦ заявку для публикации подготовленной спецификации услуги на ресурсе. Спецификация должна быть приложена к заявке
  2. После аудита спецификация услуги будет размещена на ресурсе
  3. Выполнить вывод услуги в продуктивную среду в соответствии с регламентом. При заполнении чек-листа в разделе «Номера поданных заявлений по каждому из реализованных сценариев» необходимо указать номера заявлений, отправленных с использованием API ЕПГУ
Авторизуйтесь, чтобы оставить комментарий к статье