Устанавливает параметры операций проверки (создания) ЭП (ЭМВ) и зашифрования, которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭП и ЭМВ:
- тип ЭП
- формат ЭП
- признак включения электронной метки времени данных
- признак включения электронной метки времени подписи
- порядок включения сертификатов подписанта и издателей
- режим проверки электронной метки времени подписи
- режим проверки электронной метки времени данных
- описатель данных, которые необходимо подписать
- признак возможности подписания документа несколько раз одним и тем же подписантом
Доступны следующие параметры, которые относятся к операции зашифрования:
- порядок включения сертификатов подписанта и издателей
URL-адрес запроса
https://local.cipher.kiev.ua:9091/api/v1/ticket/{uuid}/option
Метод
PUT
Параметры запроса
| uuid | String | Идентификатор сессии |
Настраиваемые заголовки запроса
| Content-Type | application/json |
Параметры JSON объекта запроса
| Имя | Тип | Описание | Допустимые значения |
|---|---|---|---|
| signatureType | String | Тип ЭП | attached - встроенная ЭП, ЭП хранится вместе с подписанными данными * detached - открепленная ЭП, ЭП хранится отдельно от подписанных данных |
| embedSignatureTs | String | Признак включения электронной метки времени ЭП | true - встраивать электронную метку времени подписи При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedSignatureTs игнорируется. |
| embedDataTs | String | Признак включения электронной метки времени данных | true - встраивать электронную метку времени данных При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedDataTs игнорируется. |
| embedCertificateType | String | Порядок включения сертификатов подписанта и издателей | signerCert - добавлять только сертификат подписанта При установке параметра cadesType в значение, отличное от "undefined", значения параметра embedCertificateType игнорируется. Значение, допустимые только для операции зашифровать: signerCert - добавлять только сертификат подписанта |
| signatureTsVerifyOption | String | Режим проверки электронной метки времени подписи | * ignore - игнорировать электронную метку времени |
| dataTsVerifyOption | String | Режим проверки электронной метки времени данных | * ignore - игнорировать электронную метку времени verifyIfPresent - проверять электронную метку времени, если она присутствует verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствует |
dataToSignQualifier | String | Описатель данных, которые необходимо подписать | * notSignedBefore - данные не содержат ранее созданную подпись alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписи |
duplicateSign | String | Признак возможности подписания документа несколько раз одним и тем же подписантом | true - добавляет новую подпись, даже если документ уже был подписан подписантом |
| cadesType | String | Формат вырабатываемой электронной подписи стандарта CAdES | undefined - параметр cadesType не учитывается при выработке электронной подписи При установке параметра cadesType в значение, отличное от "undefined", значения параметров embedSignatureTs, embedDataTs, embedCertificateType игнорируются. |
| nokkCompatible | String | Признак дополнительного кодирования подписи, созданной средствами компании НОКК | true - учитывать, что подпись создана средствами НОКК и дополнительно закодирована в ASN.1 OCTET STRING * false - кодирование подписи соответствует нормативным документам |
Ответ
| Код ответа | Content-type | Допустимые параметры | Пример содержимого |
|---|---|---|---|
| 200 | application/json | message | {"message": "Запрос на установку настроек сессии выполнен.", } } |
| 503 | application/json | message | {"message" : "Сервис хранения данных не запущен." } |
| 400 | application/json | 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:9091/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;
}
})