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

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

Доступні наступні параметри, які відносяться до операції зашифрування:

  • порядок включення сертифікатів підписанта та видавців
URL-адреса запиту

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

Метод

PUT

Параметри запиту
uuidStringІдентифікатор сесії
Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON об'єкта запиту
Ім'яТипОписДопустимі значення
signatureTypeStringТип ЕПattached - вбудований ЕП, ЕП зберігається разом з підписаними даними
* detached - відкріплений ЕП, ЕП зберігається окремо від підписаних даних
embedSignatureTsStringОзнака включення ЕПЧ підпису

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

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

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

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

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

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

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

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

Значення, допустимі лише для операції зашифрування:

signerCert - додавати лише сертифікат підписанта
signerAndCaCert - додавати сертифікат підписанта та сертифікати видавців
* nothing - не додавати сертифікати

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

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

dataTsVerifyOptionStringРежим перевірки ЕПЧ даних* ignore - ігнорувати ЕПЧ
verifyIfPresent - перевіряти ЕПЧ, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти ЕПЧ та повертати помилку, якщо вона відсутня

dataToSignQualifier

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

duplicateSign

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

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

cadesTypeStringФормат створеного ЕП за стандартом CAdES

undefined - параметр cadesType не враховується при створенні ЕП
CAdESBES - базовий ЕП
CAdEST - ЕП, який містить ЕПЧ підпису
* CAdESXLong - ЕП, який містить ЕПЧ підпису та повний набір даних для перевірки.

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

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

Відповідь
Код відповіді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Параметри та їх значення, яке було встановлено після виконання запиту