Versions Compared

Key

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

Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭП. Для внутреннего форматирования метаданных возможно использовать HTML разметку.
Данные сессии, для которых будут производиться операции ЭП и ЭМВ, должны быть обязательно загружены перед установкой метаданныхМетадані використовуються для надання користувачу додаткової інформації у випадку запиту на дозвіл використання ЕП. Для внутрішнього форматування метаданих можливе використання HTML розмітку.
Дані сесії, для яких будуть здійснюватися операції ЕП та ЕПЧ, мають бути обов'язково завантажені перед встановленням метаданих. 

URL-

...

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

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

Метод

PUT

...

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

...

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

...

запиту
Content-Typeapplication/json
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'яИмяТипОписаниеОписДопустимые значенияДопустимі значення
metaDataStringДополнительная информация об подписываемых данныхТекстовая строка. Возможно использовать HTML разметку.
Ответ
Додаткова інформація про дані, що підписуютьсяТекстовий рядок. Можна використовувати HTML розмітку.
Відповідь
Код відповідіКод ответаContent-typeДопустимые параметрыДопустимі параметриПриклад вмістуПример содержимого
200application/jsonmessage
{
       "message" : "МетаданныеМетадані длясесії сессииуспішно успешно загруженызавантажені.",
}
503application/jsonmessage
{
       "message" : "СервисСервіс выполнениявиконання криптографическихкриптографічних операцийоперацій не запущензапущено."
}
400application/jsonmessage
{
       "message" : "ДанныеДані сессиисесії не былибули загруженызавантажені перед установкойвстановленням метаданныхметаданих."
}

...

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

...

Опис результату проведення операції
Приклад коду на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url: "https://local.cipher.kiev.ua:9091/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/metadata",
    type: "PUT",
    dataType: "json",
    data: JSON.stringify({metaData: "<h1>дополнительное<h1>додатковий описание<опис</h1>"})
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "ОшибкаПомилка при установкевстановлені метаданныхметаданих." : xhr.responseText;
    }
})

...