View Source

Устанавливает параметры операций проверки (создания) ЭП (ЭМВ), которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭП и ЭМВ:

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

URL-адрес запроса

https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/option

Метод

PUT

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

uuid

String

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

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

Content-Type

application/json

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

Имя

Тип

Описание

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

signatureType

String

Тип ЭП

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

embedSignatureTs

String

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

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

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

embedDataTs

String

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

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

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

embedCertificateType

String

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

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

При установке параметра 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 - электронная подпись, содержащая электронную метку времени от электронной подписи и полный набор данных для проверки.

При установке параметра 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

var selectedOptions = {
    signatureType: "detached",
    embedCertificateType: "nothing",
    embedSignatureTs: "false",
    embedDataTs: "false",
    signatureTsVerifyOption: "ignore",
    dataTsVerifyOption: "ignore"
};
$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/option",
    type: "PUT",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(selectedOptions)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    settedOptions = jsonResponse.settedOptions;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при установке настроек сессии." : xhr.responseText;
    }
})