Page History

...

Метод

PUT

Параметры запроса

uuid

String

Идентификатор сессии

Настраиваемые заголовки запроса

Content-Type

application/json

Параметры JSON объекта запроса

Имя

Тип

Описание

Допустимые значения

signatureType

String

Тип ЭП

attached - встроенная ЭП, ЭП хранится вместе с подписанными данными
* detached - открепленная ЭП, ЭП хранится отдельно от подписанных данных

embedSignatureTs

String

Признак включения электронной метки времени подписи

true - встраивать электронную метку времени ЭП
* false - не встраивать электронную метку времени ЭП

Note
При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedSignatureTs игнорируется.

embedDataTs

String

Признак включения электронной метки времени данных

true - встраивать электронную метку времени даных
* false - не встраивать электронную метку времени данных

Note
При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedDataTs игнорируется.

embedCertificateType

String

Порядок включения сертификатов подписанта и издателей

signerCert - добавлять только сертификат подписанта
signerAndCaCert - добавлять сертификат подписанта и сертификаты издателей
signerCertAndCaInfo - добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются)
* nothing - не добавлять сертификаты

Note
При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedCertificateType игнорируется.

signatureTsVerifyOption

String

Режим проверки электронной метки времени подписи

* ignore - игнорировать электронную метку времени
verifyIfPresent - проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствует

dataTsVerifyOption

String

Режим проверки электронной метки времени данных

* ignore - игнорировать электронную метку времени
verifyIfPresent - проверять электронную метку времени, если она присутствует
verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствует

tsAdditionalVerifying

String

Признак выполнения дополнительной проверки электронной метки времени

true - выполнять дополнительную проверку электронных меток времени ЭП и данных при проверке ЭП для предоставления дополнительной информации в ответе
* false - не выполнять дополнительную проверку электронных меток времени при проверке ЭП

dataToSignQualifier

String

Описатель данных, которые необходимо подписать

* notSignedBefore - данные не содержат ранее созданную подпись
alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписи

duplicateSign

String

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

true - добавляет новую подпись, даже если документ уже был подписан подписантом
* false - новая подпись не добавляется, если документ уже был подписан подписантом

caId

String

Идентификатор КПЭДУ/(А)ЦСК, который издал сертификат ключа из ключевого контейнера.

Идентификаторы поддерживаемых Сервисом КПЭДУ/(А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых КПЭДУ/(А)ЦСК

cadesType

String

Формат вырабатываемой электронной подписи стандарта CAdES

undefined - параметр cadesType не учитывается при выработке электронной подписи
CAdESBES - базовая электронная подпись.
CAdEST - электронная подпись, содержащая электронную метку времени от электронной подписи
* CAdESXLong - электронная подпись, содержащая электронную метку времени от электронной подписи и полный набор данных для проверки.

Note
При установке параметра cadesType в значение, отличное от "undefined", значения параметров embedSignatureTs, embedDataTs, embedCertificateType игнорируются.

nokkCompatible

String

Признак дополнительного кодирования подписи, созданной средствами компании НОКК

НОКК

true - учитывать, что подпись создана средствами НОКК и дополнительно закодирована в ASN.1 OCTET STRING
* false - кодирование подписи соответствует нормативным документам

* - значение по умолчанию

Ответ

Код ответа

Content-type

Допустимые параметры

Пример содержимого

200

application/json

message
settedOptions : {
    signatureType, 
    signatureTsVerifyOption,
    dataTsVerifyOption,
    embedSignatureTs,
    embedDataTs,
    embedCertificateType,
    dataToSignQualifier,
    duplicateSign
}

{
    "message": "Запрос на установку настроек сессии выполнен.",
    "settedOptions": {
       "signatureTsVerifyOption": "IGNORE",
       "embedSignatureTs": "false",
       "embedCertificateType": "NOTHING",
       "signatureType": "DETACHED",
       "dataTsVerifyOption": "IGNORE",
       "embedDataTs": "false",
       "dataToSignQualifier": "ALREADY_SIGNED",
       "duplicateSign": "true"
    }
}

503

application/json

message

{
    "message" : "Сервис хранения данных не запущен." 
}

400

application/json

message

    "message" : "Сессия отсутствует."

Параметры JSON объекта ответа

Параметр	Тип данных	Описание
message	String	Описание результата проведения операции
settedOptions	Object	Параметры и их значения, которые были установлены после выполнения запроса

Пример кода на JavaScript + jQuery 2.2.4

...

Page tree

Versions Compared

Old Version 9

New Version 10

Key

Метод

Параметры запроса

Настраиваемые заголовки запроса

Параметры JSON объекта запроса

Ответ

Параметры JSON объекта ответа

Пример кода на JavaScript + jQuery 2.2.4