...
- тип КЕП
- формат КЕП
- ознака включення ЕПЧ даних
- ознака включення ЕПЧ підпису
- порядок включення сертифікатів підписантів та видавців
- режим перевірки ЕПЧ підпису
- режим перевірки ЕПЧ даних
- опис даних, які необхідно підписати
- ознака можливості підпису документа кілька разів один і тим же підписантом
- ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа
URL-адреса запиту
https://localhost:9094ccs-dev-api.cipher.kiev.ua/ccs/api/v1/ticket/{uuid}/option
Метод
PUT
Параметри запиту
uuid | String | Ідентифікатор сесії |
...
Ім'я | Тип | Опис | Допустимі значення | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
asicForm | String | Форма Associated Signature Container | * NONE - не створювати Associated Signature Container ASIC_S - простий формат (тільки один файл в архіві) ASIC_E - розширений формат (один та більше файлів архіві) | |||||||||
signatureType | String | Тип КЕП | attached - вбудований, КЕП зберігається разом з підписаними даними
| |||||||||
embedSignatureTs | String | Ознака включення ЕПЧ підпису | true - додавання ЕПЧ підпису
| При встановленні параметру cadesType в значення,
| undefined", значення параметру "embedSignatureTs" ігнорується
| |||||||
embedDataTs | String | Ознака включення ЕПЧ даних | true - | встраивать электронную метку времени данныхдодавання ЕПЧ даних | встраивать электронную метку времени данныхдодавати ЕПЧ даних
| |||||||
embedCertificateType | String | Порядок включення сертифікатів підписантів та видавців | signerCert - | добавлять только сертификат подписантадодавати лише сертифікат підписанта | добавлять сертификат подписанта и сертификаты издателейдодавати сертифікат підписанта та сертифікати видавців | добавлять сертификат подписанта и информацию про сертификаты издателей (сами сертификаты издателей не добавляютсядодавати сертифікат підписанта та інформацію про сертифікати видавців (самі сертифікати видавців не додаються) | добавлять сертификатыдодавати сертифікати
| При установке
| в значение "CAdESXLong", значения параметра embedCertificateType игнорируется.При работе с ключами Cipher-CKS установка значений signerAndCaCert и signerCertAndCaInfo идентична установке значения signerCert - будет добавлен только сертификат подписанта
| |||
signatureTsVerifyOption | String | Режим перевірки ЕПЧ підпису | * ignore - | игнорировать электронную метку времениігнорувати електронну позначку часу | проверять электронную метку времени, если она присутствуетперевіряти електронну позначку часу, якщо вона присутня
| |||||||
dataTsVerifyOption | String | Режим перевірки ЕПЧ даних | * ignore - | игнорировать электронную метку времениігнорувати електронну позначку часу | проверять электронную метку времени, если она присутствуетперевіряти електронну позначку часу, якщо вона присутня
| |||||||
dataToSignQualifier | String | Опис даних, які необхідно підписати | * notSignedBefore - | данные не содержат ранее созданную подписьдані не містять раніше створений підпис | данные уже содержат подпись, для добавления новой будет использован режим множественной подписидані вже містять підпис, для додавання нової буде використано режим множинного підпису
| |||||||
duplicateSign | String | Ознака можливості підпису документа кілька разів один і тим же підписантом | true - | добавляет новую подпись, даже если документ уже был подписан подписантомдодає новий підпис, навіть якщо документ вже був підписаний підписантом | новая подпись новий підпис не | добавляетсядодається, | если документ уже был подписан подписантомякщо документ вже був підписаний підписантом
| |||||
caId | String | Ідентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеру | Идентификаторы поддерживаемых Сервисом КПЭДУ/(А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых КПЭДУ/(А)ЦСКІдентифікатор підтримуваних Сервісом КНЕДП необхідно попередньо отримати завдяки запиту Отримання списку підтримуваних КНЕДП | |||||||||
cadesType | String | Формат створюваного КЕП стандарту CAdES | undefinedUNDEFINED - параметр cadesType не | учитывается при выработке электронной подписивраховується при створенні електронного підпису | ||||||||
xadesType | String | Формат створюваного КЕП стандарту XAdES | * NONE - не створювати підпис у форматі XAdES
| |||||||||
Note |
| |||||||||||
nokkCompatible | String | Ознака додаткового кодування підпису, створюваної засобами компанії НОКК | true - | учитывать, что подпись создана средствами НОКК и дополнительно закодирована враховувати, що підпис створюється засобами НОКК та додатково закодована в ASN.1 OCTET STRING | кодирование подписи соответствует нормативным документамкодування підпису відповідає нормативним документам
| |||||||
exclusiveTaskExecutor | String | Ознака застосування окремого потоку для виконання криптографічних операцій, які вимагають доступ до особистого ключа: створення підпису, зашифрування, розшифрування. | true:
| выполнения криптографических операций, которые требуют доступ к личному ключу, будет выделен отдельный
| будет создан один раз и будет повторно использоваться
| сессии
| последующих операциях, которые требуют доступ к личному ключу;следует использовать в случае необходимости выполнить в рамках одной сессии больше 10 операций, которые требуют доступ к личному ключу
* false:
| выполнения криптографических операций, которые требуют доступ к личному ключу, будет использоваться общий пул потоков для выполнения криптографических операций;криптографический контекст будет создаваться каждый раз при необходимости выполнить операцию, которая требует доступ к личному ключу
|
* - значення за замовчуванням
...
Відповідь
Код ответавідповіді | Content-type | Допустимые параметры | Допустимі параметри | Приклад вмістуПример содержимого |
---|---|---|---|---|
200 | application/json | message | { | |
503 | application/json | message | { | |
400 | application/json | message | { |
...
Параметри JSON
...
обʼєкта відповіді
Параметр | Тип данныхданих | ОписаниеОпис |
---|---|---|
message | String | Описание результата проведения операцииОпис результату проведення операції |
settedOptions | Object | Параметры и их значения, которые были установлены после выполнения запроса |
Пример кода на JavaScript + jQuery 2.2.4
...
language | js |
---|
...
Параметри та їх значення, які були встановлені після виконання запиту |
...