{"id":22356361,"url":"https://github.com/do-/node-smev3-soap","last_synced_at":"2025-03-26T13:15:02.899Z","repository":{"id":64931313,"uuid":"578962858","full_name":"do-/node-smev3-soap","owner":"do-","description":"Формирование SOAP-сообщений для СМЭВ 3","archived":false,"fork":false,"pushed_at":"2022-12-19T18:19:50.000Z","size":143,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-04T21:17:19.473Z","etag":null,"topics":["smev","soap"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/do-.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-12-16T10:08:15.000Z","updated_at":"2024-04-24T10:28:16.000Z","dependencies_parsed_at":"2023-01-29T22:30:19.962Z","dependency_job_id":null,"html_url":"https://github.com/do-/node-smev3-soap","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-%2Fnode-smev3-soap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-%2Fnode-smev3-soap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-%2Fnode-smev3-soap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/do-%2Fnode-smev3-soap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/do-","download_url":"https://codeload.github.com/do-/node-smev3-soap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245659052,"owners_count":20651525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["smev","soap"],"created_at":"2024-12-04T14:10:03.659Z","updated_at":"2025-03-26T13:15:02.878Z","avatar_url":"https://github.com/do-.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![workflow](https://github.com/do-/node-smev3-soap/actions/workflows/main.yml/badge.svg)\n![Jest coverage](./badges/coverage-jest%20coverage.svg)\n\n# node-smev3-soap\n\n# Disclaimer\n\nThis software is developed solely for integration with Russian government IT systems, so the Cyrillic script is widely used in its documentation.\n\n# Описание\n\n`node-smev3-soap` -- библиотека node.js для формирования SOAP-запросов к Системе межведомственного электронного взаимодействия 3-й версии [(СМЭВ 3)](https://info.gosuslugi.ru/docs/section/%D0%A1%D0%9C%D0%AD%D0%92_3/).\n\nЗдесь рассматривается только задача составления текста сообщений в соответствии с утверждёнными [схемами](https://info.gosuslugi.ru/articles/%D0%9E%D0%BF%D0%B8%D1%81%D1%8B%D0%B2%D0%B0%D0%B5%D0%BC_%D1%82%D0%B8%D0%BF%D1%8B_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D0%BD%D0%BE%D0%B9_%D0%B8_%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%BD%D1%8B%D1%85_%D1%87%D0%B0%D1%81%D1%82%D0%B5%D0%B9_%D0%BE%D1%81%D0%BD%D0%BE%D0%B2%D0%BD%D0%BE%D0%B9_xsd-%D1%81%D1%85%D0%B5%D0%BC%D1%8B/) XML из данных, представленных обычными объектами javaScript.\n\n## Ограничения\n\nОтправка сообщений по сети, отслеживание очередей, обработка содержательной части ответов и т. п. задачи должны решаться приложениями, использующими `node-smev3-soap`, а не ей самой.\n\nПодписывание сообщений также не относится к задачам, решаемым данной библиотекой. Она генерирует XML-документы, некоторое из элементов которых помечены атрибутами `Id`. Предполагается, что электронная подпись прикрепляется вызовом отдельного сервиса перед отправкой сообщения в СМЭВ.\n\n# Установка\n```\nnpm install smev3-soap\n```\n\n# Использование \n```js\nconst {SmevSoap} = require ('smev3-soap')\nconst smevSoap = new SmevSoap ()\n\nconst OriginalMessageID = '59a8e1bd-7cdd-11ed-a125-005056a5851b'\nconst data = {\n  ExportDebtRequestsRequest: {\t\n    \"information-system-id\": \"1c33b13d-992f-4eb5-b891-7bf845fda440\",\n    \"organization-id\": \"360617e3-6813-4481-9c45-43a574f6b1af\",\n    \"request-id\": [\n      \"eb629532-8995-483f-b9fc-018ee5e5d8cd\",\n      \"fd34f457-c8a8-4b95-8a72-1b6ce00cb6c1\",\n    ],\n  }\n}\n\nconst sendRequestXML = smevSoap.sendRequest (OriginalMessageID, data, 'dom-gosuslugi-ru-smev3-debt-responses.xsd')\nconst getResponseXML = smevSoap.getResponse ()\n\nconst MessageId      = smevSoap.getMessageId (responseResponseXML)\nconst ackXML         = smevSoap.ack (MessageId)\n```\n# Конструктор\n```js\nconst smevSoap = new SmevSoap (/*{\n//  soap: '1.1',\n//  smev: '1.1',\n//  declaration: {encoding: 'UTF-8'},\n//  header: '',\n}*/)\n```\nСоздаёт экземпляр объекта, пригодный для генерации множества SOAP-сообщений с аналогичным набором опций.\n## Опции\n| Имя  | По умолчанию | Описание | Примечание |\n| ---- | ------------ | -------- | ---------- |\n| `soap`  | `'1.1'`  | Версия SOAP | Допустимо '1.1' или '1.2' |\n| `smev`  | `'1.1'`  | Версия СМЭВ | Пока допустимо только '1.1' |\n| `declaration`  | `{encoding: 'UTF-8'}` | Содержимое декларации XML | Можно подавить вывод декларации, указав `null`, или же установить собствееный `encoding`. В последнем случае, скорее всего, потребуется дополнительное перекодирование результата, поскольку XML генерируется всегда как String|\n| `header` | `undefined`  | Содержимое SOAP-элемента Header | По умолчанию (`undefined`) `Header` отсутствует. Иначе он генерируется, причём значение опции `header` подставляется внутрь как есть (без замены скобок, кавычек и т. п.). В частности, если требуется пустой `Header`, можно указать здесь строку нулевой длины (`''`)|\n\n# Методы\n## `sendRequest `\nГенерирует SOAP-конверт, содержащий элемент СМЭВ `SendRequestRequest` с содержимым (`SenderProvidedRequestData`), которое получено из заданного объекта данных по требуемой \"схеме вида сведений\".\n\n```js\nconst OriginalMessageID = '59a8e1bd-7cdd-11ed-a125-005056a5851b'\nconst data = {\n  ExportDebtRequestsRequest: {\t\n    \"information-system-id\": \"1c33b13d-992f-4eb5-b891-7bf845fda440\",\n    \"organization-id\": \"360617e3-6813-4481-9c45-43a574f6b1af\",\n    \"request-id\": [\n      \"eb629532-8995-483f-b9fc-018ee5e5d8cd\",\n      \"fd34f457-c8a8-4b95-8a72-1b6ce00cb6c1\",\n    ],\n  }\n}\n\nconst sendRequestXML = smevSoap.sendRequest (OriginalMessageID, data, 'dom-gosuslugi-ru-smev3-debt-responses.xsd'/*, {\n// Id: 1,\n// test: true,\n}*/)\n```\n### Параметры\n| Имя  | Описание | Примечание |\n| ---- | -------- | ---------- |\n| `OriginalMessageID` | Идентификатор отправляемого сообщения | В результате подставляется в элемент `MessageID` |\n| `data` | Объект данных для упаковки согласно схеме |  Подробнее о сериализации см. [`XMLMarshaller`](https://github.com/do-/node-xml-toolkit/wiki/XMLMarshaller) |\n| `path` | Путь к корневому файлу XML-схемы | Или объект [`XMLSchemata`](https://github.com/do-/node-xml-toolkit/wiki/XMLSchemata), полученный из него |\n| `options` | Набор опций | См. следующий раздел |\n\n### Опции\n| Имя  | По умолчанию | Описание | Примечание |\n| ---- | ------------ | -------- | ---------- |\n| `Id` | `'U' + OriginalMessageID` | Атрибут `Id` | Используется для обозначения подписываемого элемента. Значение самостоятельного смысла не имеет, так что необходимость в его использовании маловероятна |\n| `test` | `false` | Добавлять ли `TestMessage` | При истинном значении этой опции `TestMessage` добавляется |\n\n## `getResponse`\nГенерирует SOAP-конверт, содержащий элемент СМЭВ `GetResponseRequest`.\n\n```js\nconst getResponseXML = smevSoap.getResponse (/*, {\n// Id: 1,\n// Timestamp: new Date (),\n}*/)\n```\n### Параметры\n| Имя  | Описание | Примечание |\n| ---- | -------- | ---------- |\n| `options` | Набор опций | См. следующий раздел |\n\n### Опции\n| Имя  | По умолчанию | Описание | Примечание |\n| ---- | ------------ | -------- | ---------- |\n| `Id` | `'U9552f341-4b2b-4cb3-b0b5-fea58fa165e1'` | Атрибут `Id` |  |\n| `Timestamp` | `new Date ()` | Метка времени в `MessageTypeSelector` | |\n\n## `getMessageId`\nЧитает из данного XML содержимое первого встреченного элемента с локальным именем `MessageId`.\n```js\nconst MessageId = smevSoap.getMessageId (responseResponseXML)\n```\n\nВ отличие от остальных методов, этот не генерирует, а, наоборот, разбирает XML. Извлекаемое им значение далее нужно для составления запроса `Ack`.\n\n`responseResponseXML` должен быть полученным от СМЭВ SOAP-сообщением, содержащим `GetResponseResponse`.\n\n## `ack`\nГенерирует SOAP-конверт, содержащий элемент СМЭВ `AckRequest` для заданного `MessageID`.\n\n```js\nconst ackXML = smevSoap.ack (MessageID /*, {\n// Id: 1,\n// accepted: true,\n}*/)\n```\n### Параметры\n| Имя  | Описание | Примечание |\n| ---- | -------- | ---------- |\n| `MessageID` | Идентификатор сообщения | о получении которого требуется сообщить |\n| `options` | Набор опций | См. следующий раздел |\n\n### Опции\n| Имя  | По умолчанию | Описание | Примечание |\n| ---- | ------------ | -------- | ---------- |\n| `Id` | `'U' + OriginalMessageID` | Атрибут `Id` | |\n| `accepted` | `true` | Значение атрибута `accepted` | |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdo-%2Fnode-smev3-soap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdo-%2Fnode-smev3-soap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdo-%2Fnode-smev3-soap/lists"}