Встановлення параметрів сесії

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

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

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

https://signer.cipher.kiev.ua/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 - не додавати електронну позначку часу даних
embedCertificateType	String	Порядок включення сертифікатів підписанта та видавців	signerCert - додавати лише сертифікат підписанта signerAndCaCert - додавати сертифікат підписанта та сертифікати видавців signerCertAndCaInfo - додавати сертифікат підписанта та інформацію про сертифікат видавців (самі сертифікати видавців не додаються) * nothing - не додавати сертифікати При встановленні параметру cadesType в значення "CAdESXLong", значення параметру embedCertificateType ігнорується.
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 ігнорується.
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	Параметри та їх значення, які були встановленні після виконання запиту

Page tree

Встановлення параметрів сесії

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

Метод

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

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

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

Відповідь

Параметри JSON обʼєкта відповіді