Технические требования к разработке веб-сервисов, регистрируемых в смэв



Скачать 219.25 Kb.
Дата26.07.2014
Размер219.25 Kb.
ТипДокументы







Технические требования к разработке веб-сервисов, регистрируемых в СМЭВ

Оглавление


Технические требования к разработке веб-сервисов, регистрируемых в СМЭВ 1

Оглавление 2

1.Термины и определения 3

2.Требования к разработке и использованию интерфейсов 3

3.Требования к протоколам сетевого взаимодействия 3

4.Требования к протоколам веб-сервисов 4

5.Особые условия и ограничения при разработке веб-сервисов 5

6.Требования к обработке сообщений интерфейсом


ИС, подключенной к системе взаимодействия 5

7.Требования к структуре веб-сообщений 6

8.Требования к документированию элементов метаданных 6

9.Требования к наименованию элементов метаданных 6

10.Требования к контрольному примеру обращения к веб-сервису 7

11.Требования к системе доставки сообщений на стороне всех участников взаимодействия 8

12.Требования к использованию нормативно-справочной информации 8

Приложение 1. Служебные теги SOAP-сообщений 9





  1. Термины и определения


ЕПГУ – Единый Портал Государственных Услуг

РПГУ – Региональный Портал Государственных Услуг

СМЭВ ФУ – Система межведомственного взаимодействия федерального уровня

СМЭВ РУ – Система межведомственного взаимодействия регионального уровня

ЕЛК – Единый Личный Кабинет

СИА – система идентификации и аутентификации

ВИС – ведомственная информационная система

Р-ИС – региональная информационная система

Ф-ИС – федеральная информационная система

  1. Требования к разработке и использованию интерфейсов

Интерфейс информационной системы, подключаемой к системе взаимодействия, должен быть реализован в виде веб-сервиса.

Программно-аппаратные средства обеспечения защищённой интеграции информационных систем с системой взаимодействия должны обеспечивать выполнение настоящих требований.

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


  1. Требования к протоколам сетевого взаимодействия



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

  • протокол передачи гипертекста HTTP v. 1.1 – стандарт RFC 2616 инженерной группы проектировщиков информационно-телекоммуникационной сети Интернет (Internet Engineering Task Force, IETF);

  • модернизированный протокол http v. 1.
    1 с обеспечением безопасности транспортного уровня (TLS) для существующего протокола управления передачей (TCP);


  • протокол защищённых соединений SSL v. 3 / TLS – стандарт RFC 5246 инженерной группы проектировщиков информационно-телекоммуникационной сети Интернет (Internet Engineering Task Force, IETF);

  • набор протоколов IP Security для обеспечения защиты данных – стандарты RFC 4301, 4302, 4835, 2403, 2404, 2405, 4303, 4835, 5996, 2410, 2411, 2412 инженерной группы проектировщиков информационно-телекоммуникационной сети Интернет (Internet Engineering Task Force, IETF);

  • сервисы поддержки пространства имен DNS (Domain Name Services) – стандарт RFC 1035 инженерной группы проектировщиков информационно-телекоммуникационной сети Интернет (Internet Engineering Task Force, IETF).
  1. Требования к протоколам веб-сервисов



При разработке веб-сервисов необходимо придерживаться следующих спецификаций:

  • базовый профиль интероперабельности v. 1.1 – стандарт Организации по интероперабельности веб-сервисов (Web Services Interoperability Organization Basic Profile 1.1, http://www.ws-i.org/Profiles/BasicProfile-1.1-2006-04-10.html) – спецификация носит обязательный характер;

  • профиль передачи веб-сервисами бинарных приложений (WS-I Attachments Profile 1.0) – стандарт Организации по интероперабельности веб-сервисов WS-I (http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0.html http://www.ws-i.org/Profiles/AttachmentsProfile-1.0.html) – спецификация носит рекомендательный характер;

  • профиль передачи веб-сервисами бинарных приложений (SOAP Message Transmission Optimization Mechanism) – стандарт консорциума W3C (http://www.w3.org/TR/soap12-mtom/) – спецификация носит рекомендательный характер;

  • профиль связывания веб-сервисов (WS-I Simple SOAP Binding Profile 1.0) – стандарт организации по интероперабельности веб-сервисов WS-I (http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0.html, http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0.html) – спецификация носит рекомендательный характер;

  • протокол SOAP 1.1 – стандарт консорциума W3C (http://www.w3.org/TR/soap/) – спецификация носит обязательный характер;

  • язык описания веб-сервисов (Web Services Description Language, WSDL 1.1) – стандарт консорциума W3C (http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0.html, http://www.w3.org/TR/wsdl) – спецификация носит обязательный характер;

  • политика использования веб-сервисов (Web Services Policy 1.2) – проект рекомендации консорциума W3C (http://www.ws-i.org/Profiles/SimpleSoapBindingProfile-1.0.htmlhttp://www.w3.org/Submission/WS-Policy/) – спецификация носит рекомендательный характер;

  • спецификация универсального описания, обнаружения и интеграции веб-сервисов UDDI v. 3.0 (Universal Description Discovery and Integration) – стандарт Организации по развитию стандартов структурированной информации (Organization for the Advancement of Structured Information Standards, OASIS, http://www.uddi.org/specification.htm) – спецификация носит рекомендательный характер;

  • спецификация универсального описания, обнаружения и интеграции веб-сервисов UDDI v. 2.0 (Universal Description Discovery and Integration) – стандарт Организации по развитию стандартов структурированной информации (Organization for the Advancement of Structured Information Standards, OASIS, http://www.uddi.org/specification.htm) – спецификация носит рекомендательный характер.

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

  • расширяемый язык разметки XML (Extensible Markup Language) – в соответствии с набором стандартов консорциума W3C (http://www.w3.org/XML);

  • XML-схема (XML Schema 1.1, также допускается использование XML Schema 1.0) – стандарты консорциума W3C, специфицированные в документах:

    • XML-схемы Часть 1: Структуры (http://www.w3.org/TR/xmlschema-1/structures),

    • XML-схемы Часть 2: Типы данных (http://www.w3.org/TR/xmlschema-2/datatypes);

  • расширяемый язык таблиц стилей XSL v. 1.1 (Extensible Stylesheet Language) – стандарт консорциума W3C (http://www.w3.org/TR/xsl) определяющий XSL-преобразование (XSL Transformation) спецификацией (http://www.w3.org/TR/xslt).



  1. Особые условия и ограничения при разработке веб-сервисов

При разработке веб-сервисов должны быть соблюдены следующие особые условия и ограничения:



  • согласно спецификации WS-I Basic Profile 1.1 все WSDL и XSD файлы должны быть кодированы в кодировке UTF-8 или UTF-16 (с указанием этой кодировки в заголовке XML);

  • в WSDL описании веб-сервиса запрещены двунаправленные циклические ссылки из файла WSDL(1) на файл WSDL(2), если одновременно при этом файл WSDL(2) содержит ссылку на файл WSDL(1), несмотря на то, что спецификация WSDL 1.1 это допускает. Однонаправленные ссылки между файлами WSDL и XSD допустимы в любом количестве и сочетании;

  • веб-сервис считается доступным только при одновременной доступности и точки доступа (endpoint) веб-сервиса и WSDL-писания веб-сервиса. Если не доступна точка доступа (endpoint) веб-сервиса, не должно быть доступно и WSDL-описание веб-сервиса, и, наоборот, если недоступно WSDL-описание веб-сервиса, то не должна быть доступна точка доступа (endpoint) веб-сервиса. Доступность веб-сервиса обеспечивает Поставщик веб-сервиса.

  • необходимо использовать encoding типа Document/Literal
  1. Требования к обработке сообщений интерфейсом
    ИС, подключенной к системе взаимодействия

Входящие веб-сообщения, полученные по каналам связи системы взаимодействия, проходят контроль в следующем порядке:



  • проверка ЭЦП веб-сообщения;

  • формально-логическая проверка веб-сообщения.

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

Веб-сообщения, ЭЦП для которых подтверждена, подвергаются формально-логической проверке значений реквизитов веб-сообщения.

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

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

Если принятое и успешно прошедшее процедуры контроля электронное сообщение является сообщением запроса на предоставление электронной услуги, то ИС Поставщика разрешает использование данного веб-сервиса.

Если принятое и успешно прошедшее процедуры контроля электронное сообщение является извещением о готовности данных, то ИС Получателя при необходимости инициирует сервис запроса этих данных.


  1. Требования к структуре веб-сообщений

Требования к общей структуре SOAP-сообщения:



  • soap:header (заголовок веб-сообщения системы взаимодействия);

  • soap:body (тело веб-сообщения системы взаимодействия);

  • soap:Fault (сообщение об ошибке).

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

  1. Требования к документированию элементов метаданных

Все элементы метаданных в XML-схеме должны быть документированы на русском языке.

Документирование элементов метаданных рекомендуется выполнять с использованием конструкции XML Schema:



Текст описания

Синтаксическую конструкцию XML Schemaрекомендуется применять только в качестве вспомогательных комментариев к XML схеме, если это необходимо, и не использовать для документирования элементов метаданных.


  1. Требования к наименованию элементов метаданных

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

Наименования, обозначающие общепринятые аббревиатуры, подлежат транслитерации на латиницу.

В исключительных случаях, если в английском языке отсутствует слово или словосочетание, достаточно однозначно определяющее описываемое понятие или допускающее большое количество вариантов обратного перевода, допустимо использовать транслитерацию на латинский алфавит, производимую согласно ГОСТ 7.79-2000 (ИСО 9-95) «Правила транслитерации кирилловского письма латинским алфавитом».

Все слова в наименовании элемента метаданных рекомендуется использовать полностью, без сокращений.

Порядок записи слов в наименовании, в которых используется два или более слова, должен соответствовать правилам английского языка. Слова должны записываться подряд, без пробела и других знаков между ними.

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

По согласованию с Оператором системы взаимодействия допускается использование в качестве первого (а также единственного) слова с прописной (заглавной) буквы.

В наименования простых и составных типов (simpleType, complexType) для обозначения их отличия от элементов (element), рекомендуется добавлять суффикс «Type».

По согласованию с Оператором системы взаимодействия при наименовании элементов метаданных допускается использование кириллицы.


  1. Требования к контрольному примеру обращения к веб-сервису

Под контрольным примером обращения к веб-сервису понимается пример обращения к веб-сервису и ответа веб-сервиса на указанное обращение. Контрольный пример обращения и ответа должен быть предоставлен поставщиком в формате SOAP.

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

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

Регистрация веб-сервиса информационной системы поставщика и/или потребителя может считаться завершенной только при условии успешного выполнения контрольного примера, которое предполагает совпадение ответа веб-сервиса с ответом, приведенным в контрольном примере, либо, при объективной невозможности возврата веб-сервисом повторяемых данных, – его соответствие описанию логики формирования ответа, которое в подобных случаях должно сопровождать предоставляемый контрольный пример (к примеру, веб-сервис возвращает номер зарегистрированного обращения, который не может повторяться, - в этом случае контрольный пример сопровождается указанием этого факта).

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



  1. Требования к системе доставки сообщений на стороне всех участников взаимодействия

Интерфейс информационной системы участника взаимодействия должен обеспечивать доставку неискаженных сообщений в рамках информационного обмена между информационной системой данного участника взаимодействия и системой взаимодействия в установленные (регламентированные) сроки.

Интерфейс системы взаимодействия должен обеспечивать доставку неискажённых сообщений с определенным интервалом времени ожидания ответа на запрос всеми участниками взаимодействия.

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

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

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



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

  1. Требования к использованию нормативно-справочной информации



Информационная система, подключаемая к системе взаимодействия, должна использовать общероссийские классификаторы технико-экономической и социальной информации.

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


Приложение 1. Служебные теги SOAP-сообщений


Общее описание служебных тегов

  1. Веб-сервисы региональных ИС при запросах на оказание услуг в электронном виде должны обеспечивать корректную обработку входящих сообщений, содержащих следующие служебные теги: унифицированный заголовок запроса, специализированный заголовок.

  2. Исходящие из региональных ИС SOAP-сообщения должны содержать следующие служебные теги: унифицированный заголовок ответа, специализированный заголовок возврата результата/статуса.

  3. Унифицированный заголовок запроса содержится в xml-теге RequestHeader, являющемся дочерним по отношению к тегу soap:body (тело электронного сообщения системы взаимодействия). RequestHeader содержит следующие теги:



token

String

OrgExternal

OrgExternal

String

dateTime

Documents


Принципы заполнения полей в RequestHeader:

authToken – Р-ИС должна получить токен безопасности в СИА, чтобы можно было вернуть ответ, который будет обработан (на текущий момент каждой Р-ИС будет выдан постоянный код токен, который будет необходимо проставлять в теге);

requestId – Код заявки в ЕЛК;

requestInitiatorCode – Данные о системе-инициаторе взаимодействия;

orgRegistrator – Данные о системе, зарегистрировавшей обращение;

requestDate – Дата регистрации запроса;

documents – Документы по обращению.


  1. Специализированный заголовок запроса на оказание услуг в электронном виде содержится в xml-теге EServiceHeader, являющемся дочерним по отношению к тегу soap:body. Данные заполняются порталом, инициирующим взаимодействие.



Number

Number

String</reestrId>

Number

dateTime</orderDate>





  1. Унифицированный заголовок ответа содержится в xml-теге ResponseHeader, являющемся дочерним по отношению к тегу soap:body.



String</authToken>

dateTime

OrgExternal


String



Number

String




В ResponseHeader принципы заполнения полей:

authToken – Р-ИС должна получить токен безопасности в СИА, чтобы можно было вернуть ответ, который будет обработан (на текущий момент каждой Р-ИС будет выдан постоянный код токен, который будет необходимо проставлять в теге);

responseDate – дата ответа со стороны Р-ИС;

requestInitiatorCode – данные о системе-инициаторе взаимодействия;

requestIdRef – указывается код исходного запроса, пришедший в запросе в теге RequestHeader.requestId;

errorCode –указывается код в случае возникновения ошибки;

errorMessage – указывается описание ошибки.


  1. Cпециализированный заголовок возврата результата/статуса содержится в xml-теге EServiceResult, являющемся дочерним по отношению к тегу soap:body.



Number

String

Number</ extOrderNumber>

Urls

Documents

Any


В EServiceResult принципы заполнения полей:

orderStatusId – код статуса исполнения услуги (см. справочник кодов статусов ниже);

commentпроизвольный комментарий к статусу исполнения услуги, который будет выводиться в Личном кабинете пользователя (например, статус – «Отправлено ведомству», комментарий – «Идет согласование в Министерстве …»);

extOrderNumber - уникальный идентификатор принятого заявления в Р-ИС;

urls – используются, если передается множество структур, описываемых ссылки на документы с результатами услуги (или документами с мотивированным отказом), сохраненные в Р-ИС. Описание структуры:

documentId - Идентификатор ссылки, уникальный как минимум в рамках обращения;

mimeType - Тип MIME бинарного образа документа;

documentTypeCode - Код типа документа согласно единому справочнику документов, фигурирующих в регламентах (ожидается от NVision);

documentName - Название документа (обязательно к заполнению в случае, если имеется несколько документов одного типа в рамках обращения);

text - Краткое содержание, дополнительная информация;

url – url ссылки.

documentsиспользуются, если передается множество структур, описываемых MTOM-вложения с результатами услуги (или с мотивированным отказом). Описание структуры:

documentId - Идентификатор документа, уникальный как минимум в рамках обращения. Предполагается использовать его в качестве аргумента при вызове сервиса извлечения бинарного образа документа;

mimeType - Тип MIME бинарного образа документа;

documentTypeCode - Код типа документа согласно единому справочнику документов, фигурирующих в регламентах (ожидается от NVision);

documentName - Название документа (обязательно к заполнению в случае, если имеется несколько документов одного типа в рамках обращения);

text - Краткое содержание, дополнительная информация;

content - Вложение

XML – структурированное описание специфических результатов Р-ИС по услуге.



  1. Структура soap:body сообщения-запроса от Портала, доставляемого в Р-ИС через СМЭВ-Р, состоит из двух служебных тегов RequestHeader и EServiceHeader, а также структурированного описания сведений, обеспечивающих исполнение услуги.



token

String

OrgExternal

OrgExternal

String

dateTime

Documents





Number

Number

String</reestrId>

Number

dateTime</orderDate>

===============================================================

Структурированное описание сообщения, передаваемого в Р-ИС,

обеспечивающий исполнение услуги

===============================================================

-->
В ответ на этот запрос необходимо вернуть результат в сообщении, содержащем в обязательном порядке ResponseHeader и EServiceResult. Специфические данные с результатами исполнения услуги передаются в произвольной структуре в теге XML.




String</authToken>

dateTime

OrgExternal


String



Number

String







Number

String

Number</extOrderNumber>

Urls

Documents

Any




  1. Если результат услуги предоставляется пользователю спустя некоторое время, в течение которого идет исполнение услуги в ВИС, считаем, что заказываемая услуга исполняется в асинхронном режиме. Во время исполнения услуги Р-ИС может периодически вызывать веб-сервис ЕЛК для актуализации статуса исполнения услуги.

При приеме заявки на исполнение услуги от СМЭВ-Р, при обновлении статусов исполнения услуги, при отправке окончательных результатов исполнения услуги Р-ИС должна отправлять ответ с унифицированным заголовком ответа ResponseHeader и унифицированным ответом для исполнения услуг EServiceResult.
При асинхронном режиме Р-ИС в случае успешной отработке веб-сервиса по приему данных для исполнения услуги должна вернуть в ответе измененный статус заявки и уникальный идентификатор принятого заявления в Р-ИС. Этот уникальный идентификатор должен быть записан в тег extOrderNumber для того, чтобы была возможность связать асинхронно возвращенный результат с запросом.


  1. Альтернативный вариант: Если результаты услуги предоставляются в асинхронном режиме, а в Р-ИС не создаётся уникального идентификатора заявления, то Р-ИС должна при приеме заявки сохранить у себя номер заявки ЛК, пришедший в теге RequestHeader.requestId. При дальнейшем исполнении услуги Р-ИС должна обновлять статусы и предоставлять результаты с указанием этого номера заявки ЛК в теге ResponseHeader.requestIdRef

  2. XSD – схема с описанием используемых в заголовках типов данных






















































































































































































































































Похожие:

Технические требования к разработке веб-сервисов, регистрируемых в смэв iconСистема композиции веб-сервисов на основе их семантических описаний
Представленная система позволяет быстро и легко создавать описания композиции веб-сервисов на языке owl-s, что позволит разработчикам...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconСемантический поиск и интеграция веб-сервисов на основании их owl-s описаний
В докладе проводится обзор технологии семантических веб-сервисов и описывается система семантического поиска и автоматической интеграции...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconОрганизация межведомственного взаимодействия с Росреестром через интерфейс веб-сервисов по каналам смэв

Технические требования к разработке веб-сервисов, регистрируемых в смэв iconОрганизация межведомственного взаимодействия с Росреестром через интерфейс веб-сервисов по каналам смэв

Технические требования к разработке веб-сервисов, регистрируемых в смэв iconИнтеграция систем управления содержимым сайта и генерации шаблонов интернет- страниц с использованием веб-сервисов
Для экономного создания сайтов, соответствующих современным технологиям, предлагается модель интеграции системы управления содержимым...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconПрограмма для запуска веб-сайта на локальном компьютере
Установка и запуск сервисов должны производиться из-под учетной записи администратора, чтобы иметь возможность записи файлов в системный...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconСистема динамической композиции веб-сервисов на основе их wsdl и owl-s описаний
Данная система предназначена для разработчиков программного обеспечения, желающих при помощи простых манипуляций создать и использовать...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconСистема стандартов безопасности труда каски защитные общие технические требования. Методы испытаний
Настоящий стандарт устанавливает общие технические требования, методы испытаний, требования к маркировке для защитных касок и требования,...
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconТехнические требования к рекламным модулям Общие условия
Настоящие технические требования являются стандартом при приеме оригинал-макета и размещении (публикации) рекламы
Технические требования к разработке веб-сервисов, регистрируемых в смэв iconСпециальные технические требования
Настоящие Технические требования (далее – тт) распространяются на все автомобили, принимающие участие в автомобильных кольцевых гонках...
Разместите кнопку на своём сайте:
ru.convdocs.org


База данных защищена авторским правом ©ru.convdocs.org 2016
обратиться к администрации
ru.convdocs.org