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 -

проверять метку времени и возвращать ошибку, если она отсутствует

перевіряти ЕПЧ та повертати помилку, якщо вона відсутня
dataTsVerifyOption	String	Режим

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

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

* ignore -

игнорировать метку времени

ігнорувати ЕПЧ
verifyIfPresent -

проверять метку времени, если она присутствует

перевіряти ЕПЧ, якщо вона присутня
verifyOrFailIfNotPresent -

проверять метку времени и возвращать ошибку, если она отсутствует

перевіряти ЕПЧ та повертати помилку, якщо вона відсутня
dataToSignQualifier	String

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

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

* notSignedBefore -

данные не содержат ранее созданную подпись

дані не містять раніше створений ЕП
alreadySigned -

данные уже содержат подпись, для добавления новой будет использован режим множественной подписи

дані вже містять ЕП, для додавання нової буде використано режим множинного ЕП
duplicateSign	String

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

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

и тем

і тим же

подписантом

підписантом

true -

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

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

новая подпись

новий ЕП не

добавляется

додається,

если документ уже был подписан подписантом

якщо документ був підписаний цим же підписантом
cadesType	String	Формат

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

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

* undefined

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

учитывается при выработке электронной подписи
CAdESBES - базовая цифровая подпись.
CAdESC - цифровая подпись, содержащая метку времени от цифровой подписи и ссылки на полный набор данных для проверки
CAdESEPES - базовая цифровая подпись с указанием политики цифровой подписи
CAdEST - цифровая подпись, содержащая метку времени от цифровой подписи
CAdESXLong - цифровая подпись, содержащая метку времени от цифровой подписи и полный набор данных для проверки

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

Note
При

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

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

значение

значення,

отличное от

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

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

значення параметрів embedSignatureTs, embedDataTs, embedCertificateType

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

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

nokkCompatible

String

Признак дополнительного кодирования подписи, созданной средствами компании НОККrue - учитывать, что подпись создана средствами НОКК и дополнительно закодирована

Ознака додаткового кодування підпису, створеного засобами компанії НОКК

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 15

New Version Current

Key

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

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

Метод

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

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

запиту

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

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

Відповідь

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

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