Встановлюються параметри операцій перевірки (створення) КЕП (ЕПЧ), які використовуються в контексті конкретної сесії.
Доступні наступні параметри, які відносяться до операцій КЕП та ЕПЧ:
- тип КЕП
- формат КЕП
- ознака включення ЕПЧ даних
- ознака включення ЕПЧ підпису
- порядок включення сертифікатів підписантів та видавців
- режим перевірки ЕПЧ підпису
- режим перевірки ЕПЧ даних
- опис даних, які необхідно підписати
- ознака можливості підпису документа кілька разів один і тим же підписантом
- ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа
URL-адреса запиту
https://localhost:9094/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 - встраивать электронную метку времени данных |
| embedCertificateType | String | Порядок включення сертифікатів підписантів та видавців | signerCert - добавлять только сертификат подписанта При установке параметра cadesType в значение "CAdESXLong", значения параметра embedCertificateType игнорируется. При работе с ключами Cipher-CKS установка значений signerAndCaCert и signerCertAndCaInfo идентична установке значения signerCert - будет добавлен только сертификат подписанта. |
| signatureTsVerifyOption | String | Режим перевірки ЕПЧ підпису | * ignore - игнорировать электронную метку времени |
| dataTsVerifyOption | String | Режим перевірки ЕПЧ даних | * ignore - игнорировать электронную метку времени verifyIfPresent - проверять электронную метку времени, если она присутствует verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствует |
dataToSignQualifier | String | Опис даних, які необхідно підписати | * notSignedBefore - данные не содержат ранее созданную подпись alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписи |
duplicateSign | String | Ознака можливості підпису документа кілька разів один і тим же підписантом | true - добавляет новую подпись, даже если документ уже был подписан подписантом |
| caId | String | Ідентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеру | Идентификаторы поддерживаемых Сервисом КПЭДУ/(А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых КПЭДУ/(А)ЦСК |
| cadesType | String | Формат створюваного КЕП стандарту CAdES | undefined - параметр cadesType не учитывается при выработке электронной подписи При установке параметра cadesType в значение, отличное от "undefined", значение параметра embedSignatureTs игнорируется. |
| nokkCompatible | String | Ознака додаткового кодування підпису, створюваної засобами компанії НОКК | true - учитывать, что подпись создана средствами НОКК и дополнительно закодирована в ASN.1 OCTET STRING |
| exclusiveTaskExecutor | String | Ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа: створення підпису, зашифрування, розшифрування. | true:
* false:
|
* - значення за замовчуванням
Ответ
| Код ответа | Content-type | Допустимые параметры | Пример содержимого |
|---|---|---|---|
| 200 | application/json | message | { |
| 503 | application/json | 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://localhost:9094/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;
}
})