Page History

...

Content-Type

application/json

Параметри JSON

...

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

Імʼя

Ім'я	Тип	Опис	Допустимі значення
asicForm	String	Форма Associated Signature Container	* NONE - не створювати Associated Signature Container ASIC_S - простий формат (тільки один файл в архіві) ASIC_E - розширений формат (один та більше файлів архіві)
signatureType	String	Тип

ЕП

КЕП	attached - вбудований

ЕП

, КЕП зберігається разом

із

з підписаними даними
* detached - відкріплений

ЕП

, КЕП зберігається окремо від підписаних даних

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

embedSignatureTs

String

Ознака включення

електронної позначки часу

ЕПЧ підпису

true -

додавати електронну позначку часу

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

електронну позначку часу

ЕПЧ підпису

Note

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

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

Якщо для параметра cadesType вказане значення відмінне від "UNDEFINED".
При створенні електронного підпису формату XAdES.

embedDataTs

String

Ознака включення

електронної позначки часу

ЕПЧ даних

true -

додавати електронну позначку часу

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

електронну позначку часу

ЕПЧ даних

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

даних

embedCertificateType

String

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

підписанта

підписантів та видавців

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

сертифікат

сертифікати видавців (самі сертифікати видавців не додаються)
* nothing - не додавати сертифікати

Note

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

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

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

signatureTsVerifyOption

String

Режим перевірки

електронної позначки часу

ЕПЧ підпису

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

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

dataTsVerifyOption

String

Режим перевірки

електронної позначки часу

ЕПЧ даних

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

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

dataToSignQualifier

String

Описувач

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

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

використано

використано режим множинного підпису

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

duplicateSign

String

Ознака можливості

підписання документу

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

одним

один і тим же підписантом

true -

додавати

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

підписано

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

документу

документ вже був

підписано підписантом

підписаний підписантом

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

cadesType

String

Формат

електронного підпису

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

undefined

UNDEFINED - параметр cadesType не враховується при створенні електронного підпису

CAdESBES

NONE - не створювати підпис у форматі CAdES
CADES_BES - базовий електронний підпис

.

CAdEST

CADES_T - електронний підпис, який містить електронну

порзначку

позначку часу від електронного підпису
*

CAdESXLong

CADES_X_LONG - електронний підпис, який містить електронну позначку часу підпису від електронного підпису та повний набір даних для перевірки

xadesType

String

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

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

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

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

.

nokkCompatible

String

Ознака додаткового кодування підпису,

створений

створюваної засобами компанії НОКК

true -

враховуючи

враховувати, що підпис

створений

створюється засобами НОКК та додатково

закодований у

закодована в ASN.1 OCTET STRING
* false - кодування підпису

відповідно до нормативних документів

...

відповідає нормативним документам

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

Відповідь

Код відповіді

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" : "Сесія відсутня." 
}

...

Page tree

Versions Compared

Old Version 18

New Version 19

Key

Параметри JSON

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

Відповідь