You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

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

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

https://localhost:9092/api/v1/ticket/{uuid}/option

Метод

PUT

Параметри запиту
uuidStringІдентифікатор сесії
Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON обʼєкта запиту
ІмʼяТипОписДопустимі значення
signatureTypeStringТип ЕПattached - вбудований ЕП, зберігається разом із підписаними даними
* detached - відкріплений ЕП, зберігається окремо від підписаних даних
embedSignatureTsStringОзнака включення електронної позначки часу підпису

true - додавати електронну позначку часу підпису
* false - не додавати електронну позначку часу підпису

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

embedDataTsStringОзнака включення електронної позначки часу даних

true - додавати електронну позначку часу даних
* false - не додавати електронну позначку часу даних

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

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

При встановленні параметру cadesType в значення "CAdESXLong", значення параметру embedCertificateType ігнорується.

signatureTsVerifyOptionStringРежим перевірки електронної позначки часу підпису

* ignore - ігнорувати електронну позначку часу
verifyIfPresent - перевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

dataTsVerifyOptionStringРежим перевірки електронної позначки часу даних* ignore - ігнорувати електронну позначку часу
verifyIfPresent - перевіряти електронну позначку часу, якщо вона присутня
verifyOrFailIfNotPresent - перевіряти електронну позначку часу та повертати помилку, якщо вона відсутня

dataToSignQualifier

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

duplicateSign

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

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

cadesTypeStringФормат електронного підпису стандарту CAdES

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

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

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

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
var selectedOptions = {
    signatureType: "detached",
    embedCertificateType: "nothing",
    embedSignatureTs: "false",
    embedDataTs: "false",
    signatureTsVerifyOption: "ignore",
    dataTsVerifyOption: "ignore"
};
$.ajax({
    url: "https://localhost:9092/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/option",
    type: "PUT",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(selectedOptions)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    settedOptions = jsonResponse.settedOptions;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Помилка при встановленні налаштувань сесії." : xhr.responseText;
    }
})



  • No labels