Page History

Встановлення параметрів операції перевірки (створення) ЕП (ЕПЧ), які використовуються в контексті конкретної сесії.
Доступні наступні параметри, які відносяться до операцій ЕП та ЕПЧ:

тип ЕП
формат ЕП
ознака включення електронної позначки часу даних
ознака включення електронної позначки часу підпису
порядок включення сертифіката підписанта та видавців
режим перевірки електронного позначки часу даних
режим перевірки електронного позначки часу підпису
ознака виконання додаткової перевірки електронної позначки часу
описувач даних, які необхідно підписати
ознака можливості підписання документів одним і тим же підписантом

URL-адреса запиту

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

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

...

https://localhost:9092/api/v1/ticket/{uuid}/option

Метод

PUT

...

Параметри запиту

uuid

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

сессииІдентифікатор сесії

...

Налаштовувані заголовки

...

запиту

Content-Type

application/json

...

Параметри JSON

...

обʼєкта запиту

ИмяІмʼя

Тип

ОписаниеОпис

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

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 игнорируетсяігнорується.

signatureTsVerifyOption

String

Режим проверки электронной метки времени подписиперевірки електронної позначки часу підпису

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

dataTsVerifyOption

String

Режим проверки электронной метки времени данных перевірки електронної позначки часу даних

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

dataToSignQualifier

StringОписатель

данных, которые необходимо подписатьОписувач даних, які необхідно підписати

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

duplicateSign

String

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

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

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

cadesType

String

Формат вырабатываемой электронной подписи стандарта електронного підпису стандарту CAdES

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

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

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

Code Block

language	js

var selectedOptions = {
    signatureType: "detached",
    embedCertificateType: "nothing",
    embedSignatureTs: "false",
    embedDataTs: "false",
    signatureTsVerifyOption: "ignore",
    dataTsVerifyOption: "ignore"
};
$.ajax({
    url: "https://localhost:9092/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 16

New Version 17

Key

URL-адреса запиту

https://localhost:9092/api/v1/ticket/{uuid}/option

Метод

Параметри запиту

Налаштовувані заголовки

запиту

Параметри JSON

обʼєкта запиту

Відповідь

Параметри JSON

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

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