Page History

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

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

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

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

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

Устанавливает параметры операций проверки (создания) ЭП (ЭМВ) и зашифрования, которые используются в контексте определенной сессии.
Доступны следующие параметры, которые относятся к операциям ЭП и ЭМВ:

тип ЭП
формат ЭП
признак включения электронной метки времени данных
признак включения электронной метки времени подписи
порядок включения сертификатов подписанта и издателей
режим проверки электронной метки времени подписи
режим проверки электронной метки времени данных
описатель данных, которые необходимо подписать
признак возможности подписания документа несколько раз одним и тем же подписантом

Доступны следующие параметры, которые относятся к операции зашифрования:

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

...

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

Метод

PUT

...

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

uuid

StringИдентификатор

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

...

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

...

запиту

Content-Type

application/json

Параметры JSON объекта запроса

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

Ім'яИмя

Тип

ОписаниеОпис

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

signatureType

String

Тип ЭПЕП

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

embedSignatureTs

StringПризнак включения электронной метки времени ЭП

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

true - встраивать электронную метку времени подписивбудовувати ЕПЧ підпису
* false - встраивать электронную метку времени подписи вбудовувати ЕПЧ підпису

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

embedDataTs

StringПризнак включения электронной метки времени данных

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

true - встраивать электронную метку времени данныхвбудовувати ЕПЧ підпису
* false - встраивать электронную метку времени данныхвбудовувати ЕПЧ підпису

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

embedCertificateType

String

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

signerCert -

добавлять только сертификат подписанта

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

добавлять сертификат подписанта и сертификаты издателей

додавати сертифікат підписанта та сертифікати видавців
signerCertAndCaInfo -

добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляются

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

добавлять сертификаты

додавати сертифікати

Note
При

установке параметра

встановленні параметру cadesType в

значение

значення,

отличное от

відмінне від "undefined",

значения параметра

значення параметру embedCertificateType

игнорируется

ігнорується.

Note

title

Значение

Значення,

допустимые только для операции зашифровать

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

signerCert

- добавлять только сертификат подписанта

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

- добавлять сертификат подписанта и сертификаты издателей

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

- не

добавлять сертификаты

додавати сертифікати

signatureTsVerifyOption

String

Режим проверки электронной метки времени подписиперевірки ЕПЧ підпису

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

dataTsVerifyOption

String

Режим проверки электронной метки времени данных перевірки ЕПЧ даних

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

dataToSignQualifier

StringОписатель

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

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

duplicateSign

String

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

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

cadesType

String

Формат вырабатываемой электронной подписи стандарта створеного ЕП за стандартом CAdES

undefined - параметр cadesType не

учитывается при выработке электронной подписи

враховується при створенні ЕП
CAdESBES -

базовая электронная подпись

базовий ЕП
CAdEST -

электронная подпись, содержащая электронную метку времени от электронной подписи

ЕП, який містить ЕПЧ підпису
* CAdESXLong -

электронная подпись, содержащая электронную метку времени от электронной подписи и полный набор данных для проверки

ЕП, який містить ЕПЧ підпису та повний набір даних для перевірки.

Note
При

установке параметра

встановленні параметру 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

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

Пример кода на JavaScript + jQuery 2.2.4

...

language	js

...

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

Page tree

Versions Compared

Old Version 20

New Version Current

Key

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

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

Метод

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

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

запиту

Параметры JSON объекта запроса

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

Відповідь

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

Пример кода на JavaScript + jQuery 2.2.4