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

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

https://signer.cipher.kiev.ua/api/v1/ticket/{uuid}/option

Метод

PUT

Параметри запиту
uuidStringІдентифікатор сесії
Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON об'єкта запиту
Ім'яТипОписДопустимі значення
asicFormStringФорма Associated Signature Container* NONE - не створювати Associated Signature Container
ASIC_S - простий формат (тільки один файл в архіві)
ASIC_E - розширений формат (один та більше файлів архіві)
signatureTypeStringТип КЕП

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

Значення параметра ігнорується, якщо для параметра asicForm вказане значення відмінне від "NONE".


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

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

Значення параметра ігнорується:

  1. Якщо для параметра cadesType вказане значення відмінне від "UNDEFINED".
  2. При створенні електронного підпису формату XAdES.
embedDataTsStringОзнака включення ЕПЧ даних

true - додавання ЕПЧ даних
* false - не додавати ЕПЧ даних

Значення параметра ігнорується при створенні електронного підпису формату XAdES.

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

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

Значення параметру ігнорується:

  1. Якщо для параметра cadesType вказане значення "CADES_X_LONG"
  2. При створенні електронного підпису формату XAdES.
signatureTsVerifyOptionStringРежим перевірки ЕПЧ підпису

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

Значення параметру ігнорується при перевірці електронного підпису формату XAdES.

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

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

Значення параметра ігнорується при перевірці електронного підпису формату XAdES.

dataToSignQualifier

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

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

Значення параметра ігнорується при створенні електронного підпису формату XAdES.

duplicateSign

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

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

Значення параметру ігнорується при створенні електронного підпису формату XAdES.

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

UNDEFINED - параметр cadesType не враховується при створенні електронного підпису
NONE - не створювати підпис у форматі CAdES
CADES_BES - базовий електронний підпис
CADES_T - електронний підпис, який містить електронну позначку часу від електронного підпису
* CADES_X_LONG - електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки

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

* NONE - не створювати підпис у форматі XAdES
XADES_B_B - базовий електронний підпис
XADES_B_T - електронний підпис, який містить електронну позначку часу від електронного підпису
XADES_B_LT - електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки 
XADES_B_LTA - електронний підпис для тривалого (архівного) зберігання.

Значення параметра ігнорується, якщо для параметра cadesType вказане значення відмінне від "NONE".

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

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

Значення параметра ігнорується при перевірці електронного підпису формату XAdES.

Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/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"
    }
}
503application/jsonmessage
{
    "message" : "Сервіс зберігання даних не запущено." 
}
400application/jsonmessage
{
    "message" : "Сесія відсутня." 
}
Параметри JSON обʼєкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції

settedOptions

ObjectПараметри та їх значення, які були встановленні після виконання запиту