Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

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

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

  • порядок включення сертифікатів підписанта та видавців
URL-адреса запиту

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

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

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

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

...

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

Метод

PUT

...

Параметри запиту
uuidString
Идентификатор сессии
Ідентифікатор сесії

...

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

...

запиту
Content-Typeapplication/json
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'я
Имя
Тип
Описание
Опис
Допустимые значения
Допустимі значення
signatureTypeStringТип
ЭП
ЕПattached -
встроенная ЭП, ЭП хранится вместе с подписанными данными
вбудований ЕП, ЕП зберігається разом з підписаними даними
* detached -
открепленная ЭП, ЭП хранится отдельно от подписанных данных
відкріплений ЕП, ЕП зберігається окремо від підписаних даних
embedSignatureTsString
Признак включения электронной метки времени ЭП
Ознака включення ЕПЧ підпису

true -

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

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

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

вбудовувати ЕПЧ підпису

Note

При

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

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

значение

значення,

отличное от 

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

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

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

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

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


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

true -

встраивать электроннную метку времени даных

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

встраивать электронную метку времени данных

вбудовувати ЕПЧ підпису

Note

При

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

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

значение

значення,

отличное от 

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

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

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

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

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


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

signerCert -

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

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

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

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

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

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

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

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

Note

При

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

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

значение

значення,

отличное от 

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

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

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

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

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


Note
title
Значение
Значення,
допустимые только для операции зашифровать
допустимі лише для операції зашифрування:

signerCert

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

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

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

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

 

- не

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

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


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

* ignore -

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

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

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

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

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

dataToSignQualifier

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

duplicateSign

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

true -

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

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

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

новий ЕП не

добавляется

додається,

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

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

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

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

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

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

Note

При

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

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

значение

значення,

отличное от 

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

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

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

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

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


nokkCompatibleString
Признак дополнительного кодирования подписи, созданной средствами компании НОККrue - учитывать, что подпись создана средствами НОКК и дополнительно закодирована
Ознака додаткового кодування підпису, створеного засобами компанії НОККtrue - враховувати, що підпис створений засобами НОКК та додатково закодовано в ASN.1 OCTET STRING
* false -
кодирование подписи соответствует нормативным документам

...

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

Відповідь
Код
ответа
відповідіContent-type
Допустимые параметрыПример содержимого
Допустимі параметриПриклад вмісту
200application/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"
    }
}
503application/jsonmessage
{
   
    "message" : "
Сервис
Сервіс 
хранения
збереження 
данных
даних 
не
на 
запущен
запущено." 
}
400application/jsonmessage
{    
   
    "message" : "
Сессия
Сесія 
отсутствует
відсутня." 
}

...

Параметри JSON об'єкта відповіді
ПараметрТип
данных
даних
Описание
Опис
messageString
Описание результата проведения операции
Опис результату проведення операції 

settedOptions

Object
Параметры и их значения, которые были установлены после выполнения запроса
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

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