Page History

...

Ім'я

Тип

Опис

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

signatureType

String

Тип КЕП

attached - вбудований, КЕП зберігається разом з підписаними даними
* detached - відкріплений, КЕП зберігається окремо від підписаних даних

embedSignatureTs

String

Ознака включення ЕПЧ підпису

true - додавання ЕПЧ підпису
* false - не додавати ЕПЧ підпису

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

embedDataTs

String

Ознака включення ЕПЧ даних

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

embedCertificateType

String

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

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

Note

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

При работе с ключами роботі з ключами Cipher-CKS установка значений встановлення значень signerAndCaCert и signerCertAndCaInfo идентична установке значения signerCert - будет добавлен только сертификат подписантата signerCertAndCaInfo ідентично до становлення значення signerCert - буде додано лише сертифікат підписанта.

signatureTsVerifyOption

String

Режим перевірки ЕПЧ підпису

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

dataTsVerifyOption

String

Режим перевірки ЕПЧ даних

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

dataToSignQualifier

String

Опис даних, які необхідно підписати

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

duplicateSign

String

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

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

caId

String

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

Ідентифікатор підтримуваних Сервісом КНЕДП необхідно попередньо отримати завдяки запиту Отримання списку підтримуваних КНЕДП

cadesType

String

Формат створюваного КЕП стандарту CAdES

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

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

nokkCompatible

String

Ознака додаткового кодування підпису, створюваної засобами компанії НОКК

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

exclusiveTaskExecutor

String

Ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа: створення підпису, зашифрування, розшифрування.

true:

для выполнения криптографических операций, которые требуют доступ к личному ключу, будет выделен отдельный виконання криптографічних операцій, які вимагають доступ до особистого ключа, буде виділено окремий поток;
криптоконтекст будет создан один раз и будет повторно использоваться створюється одноразово та буде повторно використовуватися в рамках сессии сесії в последующих операциях, которые требуют доступ к личному ключу;следует использовать в случае необходимости выполнить в рамках одной сессии больше 10 операций, которые требуют доступ к личному ключунаступних операціях, які вимагають доступ до особистого ключа;
слід використовувати у випадку необхідності виконати в рамках сесії більше 10 операцій, які вимагають доступ до особистого ключа.

* 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

Code Block

language	js

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;
    }
})

...

Page tree

Versions Compared

Old Version 18

New Version 19

Key

Відповідь

Параметри JSON

обʼєкта відповіді

Приклад коду на JavaScript + jQuery 2.2.4