View Source

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

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

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

Метод

PUT

Параметри запиту

uuid

String

Ідентифікатор сесії

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

Content-Type

application/json

Параметри JSON об'єкта запиту

Ім'я	Тип	Опис	Допустимі значення
metaData	String	Додаткова інформація про дані, що підписуються	Текстовий рядок. Можна використовувати HTML розмітку.

Відповідь

Код відповіді

Content-type

Допустимі параметри

Приклад вмісту

200

application/json

message

{
    "message" : "Метадані сесії успішно завантажені.",
}

503

application/json

message

{
    "message" : "Сервіс виконання криптографічних операцій не запущено." 
}

400

application/json

message

{
    "message" : "Дані сесії не були завантажені перед встановленням метаданих." 
}

Параметри JSON об'єкта відповіді

Параметр	Тип даних	Опис
message	String	Опис результату проведення операції

Приклад коду на JavaScript + jQuery 2.2.4

$.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>"})
}).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;
    }
})