Встановлення параметрів операції перевірки (створення) електронного підпису/електронної позначки часу (ЕП/ЕПЧ) та зашифрування, які використовуються в контексті визначеної сесії.
Доступні наступні параметри, які відносяться до операцій ЕП та ЕПЧ:
- тип ЕП
- формат ЕП
- ознака включення ЕПЧ даних
- ознака включення ЕПЧ підпису
- порядок включення сертифікатів підписанта та видавців
- режим перевірки ЕПЧ підпису
- режим перевірки ЕПЧ даних
- опис даних, які необхідно підписати
- ознака можливості підписання документа кілька разів одним і тим же підписантом
Доступні наступні параметри, які відносяться до операції зашифрування:
- порядок включення сертифікатів підписанта та видавців
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 - вбудовувати ЕПЧ підпису вбудовувати ЕПЧ підпису
| |||||||||||||||||||
embedDataTs | StringПризнак включения электронной метки времени данных | Ознака включення ЕПЧ даних | true - вбудовувати ЕПЧ підпису вбудовувати ЕПЧ підпису
| |||||||||||||||||||
embedCertificateType | String | Порядок включения сертификатов подписанта и издателейвключення сертифікатів підписанта та видавців | signerCert - додавати лише сертифікат підписанта додавати сертифікат підписанта та сертифікати видавців додавати сертифікат підписанта та інформацію про сертифікати видавців (самі сертифікати видавців не додаються) додавати сертифікати
| |||||||||||||||||||
signatureTsVerifyOption | String | Режим проверки электронной метки времени подписиперевірки ЕПЧ підпису | * ignore - игнорировать электронную метку времениігнорувати ЕПЧ | |||||||||||||||||||
dataTsVerifyOption | String | Режим проверки электронной метки времени данных перевірки ЕПЧ даних | * ignore - игнорировать электронную метку времениігнорувати ЕПЧ verifyIfPresent - проверять электронную метку времени, если она присутствует verifyOrFailIfNotPresent - проверять электронную метку времени и возвращать ошибку, если она отсутствуетперевіряти ЕПЧ, якщо вона присутня verifyOrFailIfNotPresent - перевіряти ЕПЧ та повертати помилку, якщо вона відсутня | |||||||||||||||||||
dataToSignQualifier | StringОписатель | данных, которые необходимо подписатьОпис даних, які необхідно підписати | * notSignedBefore - данные не содержат ранее созданную подписьдані не містять раніше створений ЕП alreadySigned - данные уже содержат подпись, для добавления новой будет использован режим множественной подписидані вже містять ЕП, для додавання нової буде використано режим множинного ЕП | |||||||||||||||||||
duplicateSign | String | Признак возможности подписания документа несколько Ознака можливості підпису документу кілька раз одним и тем і тим же подписантомпідписантом | true - добавляет новую подпись, даже если документ уже был подписан подписантомдодає новий ЕП, якщо документ вже був підписаний цим же підписантом | |||||||||||||||||||
cadesType | String | Формат вырабатываемой электронной подписи стандарта створеного ЕП за стандартом CAdES | undefined - параметр cadesType не враховується при створенні ЕП базовий ЕП ЕП, який містить ЕПЧ підпису ЕП, який містить ЕПЧ підпису та повний набір даних для перевірки.
| |||||||||||||||||||
nokkCompatible | String | Признак дополнительного кодирования подписи, созданной средствами компании НОКК | Ознака додаткового кодування підпису, створеного засобами компанії НОКК | true - враховувати, що підпис створений засобами НОКК та додатково закодовано rue - учитывать, что подпись создана средствами НОКК и дополнительно закодирована в ASN.1 OCTET STRING * false - кодирование подписи соответствует нормативным документам |
...
кодування підпису відповідає нормативним нормам |
Відповідь
Код ответавідповіді | Content-type | Допустимые параметры | Допустимі параметри | Приклад вмістуПример содержимого |
---|---|---|---|---|
200 | application/json | message | { "message": "ЗапросЗапит на установкувстановлення настроекналаштування сессиисесії выполненвиконано.", } } | |
503 | application/json | message | { "message" : "СервисСервіс хранениязбереження данныхданих нена запущензапущено." } | |
400 | application/json | message | { |
...
Параметри JSON об'єкта відповіді
Параметр | Тип данныхданих | ОписаниеОпис |
---|---|---|
message | String | Описание результата проведения операцииОпис результату проведення операції |
settedOptions | Object | Параметры и их значения, которые были установлены после выполнения запроса |
Пример кода на JavaScript + jQuery 2.2.4
...
language | js |
---|
...
Параметри та їх значення, яке було встановлено після виконання запиту |