Небанковская кредитная организация
закрытое акционерное общество
«НАЦИОНАЛЬНЫЙ РАСЧЕТНЫЙ ДЕПОЗИТАРИЙ»
Технические рекомендации по использованию
Web-сервиса НРД
Москва, 2013
Аннотация
Настоящие рекомендации являются техническим документом Небанковской кредитной организации закрытого акционерного общества «Национальный расчетный депозитарий» (далее - НРД) и описывают порядок обеспечения электронного документооборота с использованием Web-сервиса НРД (далее Web-сервис).
В рекомендациях приведены описания функций, предоставляемых Web-сервисом, а также коды и описания ошибок, возвращаемых Web-сервисом.
© Небанковская кредитная организация закрытое акционерное общество «Национальный расчетный депозитарий», 2013
Оглавление
1. Используемые термины и определения 5
2. Интерфейс взаимодействия с Web-сервисом 5
2.1. Общие сведения 5
2.2. Обмен пакетами документов 6
3. Предоставляемые Web-сервисом функции 7
GetRests - Запрос об остатках ценных бумаг 7
Входные параметры: 8
Выходные параметры: 8
Формат XML rests 9
GetRestsRepo – запрос о доступных остатках по расчетным активам 10
Входные параметры: 10
Выходные параметры: 10
Формат XML RepoRecord 11
GetMarkedRests – запрос о промаркированных остатках по расчетным активам и активам обеспечения 12
Входные параметры: 12
Выходные параметры: 13
Формат XML MarkedRepoRecord 13
GetRcCreditorAssets – запрос информации по активам для расчетного РЕПО 14
Входные параметры: 15
Выходные параметры: 15
Формат XML CreditorAssetsRecord 16
GetOrderState - запрос о состоянии поручений 17
Входные параметры: 17
Выходные параметры: 18
InitTransferIn – начало отправки пакета документов 18
Входные параметры: 18
Выходные параметры: 19
PutPackage - отправка пакета документов 19
Входные параметры: 19
Выходные параметры: 20
GetTransferResult – завершение отправки пакета документов 20
Входные параметры: 20
Выходные параметры: 21
GetPackageList – получение списка пакетов из НРД 21
Входные параметры: 21
Выходные параметры: 21
Формат XML package_list 22
GetPackage - – получение пакета документов из НРД 22
Входные параметры: 23
Выходные параметры: 23
4. Коды возврата и описания ошибок 23
5. Порядок работы с Web-сервисом 25
5.1. Подключение к Web-сервису 25
5.2. Рекомендуемые СКЗИ 26
5.3. Допустимые операционные системы 26
5.4. Сертификация 27
5.5. Пример SOAP запроса к Web-сервису 27
1.Используемые термины и определения
Термины и определения, используемые в настоящих технических рекомендациях, должны пониматься в соответствии с терминами и определениями, приведенными в Правилах ЭДО НРД.
Base64 - обратимое кодирование с возможностью восстановления, основанное на позиционной системе счисления с основанием 64. Используется, например, в электронной почте для представления бинарных файлов в тексте письма (транспортное кодирование).
SOAP (Simple Object Access Protocol) – протокол для обмена произвольными сообщениями в формате XML. Является одним из стандартов, на которых базируются технологии веб-служб. Описание протокола см. http://www.w3.org/TR/2007/REC-soap12-part0-20070427/
Валидата CSP - средство криптографической защиты информации, представляющее собой программное обеспечение - криптографический провайдер, который в числе прочих функций поддерживает вычисление и проверку электронной подписи (далее - ЭП) в соответствии с ГОСТ Р 34.10-2001. Подробнее см. http://www.x509.ru/vdcsp.shtml
Депозитарный (репозитарный) код – депозитарный или репозитарный код, присвоенный клиенту в НРД.
Доверенность ЭДО - доверенность на подписание электронного документа в СЭД НРД в соответствии с Правилами ЭДО НРД.
КБ RSA - криптографическая библиотека, использующая асимметричный криптографический алгоритм RSA.
Квалифицированный сертификат - сертификат ключа проверки электронной подписи (СКПЭП) на основе КБ «Валидата CSP» (КБ «КриптоПро CSP»), выданный аккредитованным удостоверяющим центром
Неквалифицированный сертификат - сертификат ключа проверки электронной подписи (СКПЭП) на основе КБ RSA выданный неаккредитованным удостоверяющим центром.
ОС – операционная система.
Правила ЭДО – Правила электронного документооборота НРД (приложение 1 к Договору об обмене электронными документами), с которыми можно ознакомиться на официальном сайте НРД http://www.nsd.ru/ru/documents/workflow/
Хэш-код – результат преобразования массива данных в битовую строку. Используется для построения уникальных идентификаторов наборов данных и контрольного суммирования с целью обнаружения ошибок передачи данных.
ЭП – электронная подпись, определение см. в Правилах ЭДО.
2.Интерфейс взаимодействия с Web-сервисом
2.1.Общие сведения
Веб-сервис реализован с использованием SOAP-протокола версии 1.2 поверх протокола HTTP, используемого в качестве транспорта.
Запрос к Web-сервису представляет собой SOAP объект. Набор входных параметров для каждого запроса свой – см. описание функций ниже. Общие правила преобразования параметров в текст запроса следующие:
-
Если параметр строковый, он подставляется в запрос «как есть»
-
Целое число преобразуется в строку как набор цифр.
-
Действительное число преобразуется в строку как набор цифр с точкой, отделяющей целую часть от дробной.
-
Дата преобразуется в строку формата dd.mm.yyyy
-
Бинарные данные кодируются по алгоритму base64 и передаются в виде получившейся строки.
Для аутентификации клиента, обращающегося к Web-сервису, проверяется ЭП, включенная в текст сообщения в виде параметра Sign. Этот параметр формируется следующим образом:
-
Конкатенируется строка входных параметров, перечисленных через запятую, не включая параметр Sign.
-
Полученная строка подписывается ЭП, подпись сохраняется в отдельном файле.
-
Полученный таким образом бинарный файл кодируется по алгоритму base64 и передается как значение параметра Sign.
Ответ от Web-сервиса представляет собой SOAP объект из нескольких полей – см. описание выходных параметров для конкретной функции.
Последние два поля всегда:
-
errorCode – код возврата, целое число. Равен 0, если запрос выполнен успешно.
-
errorDesc – описание ошибки. Длинный текст в кодировке Юникод. Если запрос выполнен успешно, возвращается два символа OK.
Ответ не подписывается.
|