Встановлюються параметри операцій перевірки (створення) КЕП (ЕПЧ), які використовуються в контексті конкретної сесії.
Доступні наступні параметри, які відносяться до операцій КЕП та ЕПЧ:
- тип КЕП
- формат КЕП
- ознака включення ЕПЧ даних
- ознака включення ЕПЧ підпису
- порядок включення сертифікатів підписантів та видавців
- режим перевірки ЕПЧ підпису
- режим перевірки ЕПЧ даних
- ознака виконання додаткової перевірки електронної позначки часу
- опис даних, які необхідно підписати
- ознака можливості підпису документа кілька разів один і тим же підписантом
- ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа
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 - додавання ЕПЧ підпису При встановленні параметру cadesType в значення, відмінне від "undefined", значення параметру "embedSignatureTs" ігнорується. |
embedDataTs | String | Ознака включення ЕПЧ даних | true - додавання ЕПЧ даних |
embedCertificateType | String | Порядок включення сертифікатів підписантів та видавців | signerCert - додавати лише сертифікат підписанта При встановленні параметра cadesType у значення "CAdESXLong", то значення параметру embedCertificateType ігнорується. |
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 * false - кодування підпису відповідає нормативним документам |
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://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; } })