View Source

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

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

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

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

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

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

Метод

PUT

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

uuid

String

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

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

Content-Type

application/json

Параметри JSON об'єкта запиту

Ім'я

Тип

Опис

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

signatureType

String

Тип ЕП

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

embedSignatureTs

String

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

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

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

embedDataTs

String

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

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

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

embedCertificateType

String

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

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

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

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

signatureTsVerifyOption

String

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

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

dataTsVerifyOption

String

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

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

dataToSignQualifier

String

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

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

duplicateSign

String

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

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

cadesType

String

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

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

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

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