Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭП. Для внутреннего форматирования метаданных возможно использовать HTML разметку.
Данные сессии, для которых будут производиться операции ЭП и ЭМВ, должны быть обязательно загружены перед установкой метаданныхМетадані використовуються для надання користувачу додаткової інформації у випадку запиту на дозвіл використання ЕП. Для внутрішнього форматування метаданих можливе використання HTML розмітку.
Дані сесії, для яких будуть здійснюватися операції ЕП та ЕПЧ, мають бути обов'язково завантажені перед встановленням метаданих.
URL-
...
адреса запиту
https://local.cipher.kiev.ua:9091/api/v1/ticket/{uuid}/metadata
Метод
PUT
...
Параметри запиту
uuid | StringИдентификатор | сессииІдентифікатор сесії |
...
Налаштовувані заголовки
...
запиту
Content-Type | application/json |
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'яИмя | Тип | ОписаниеОпис | Допустимые значенияДопустимі значення |
---|---|---|---|
metaData | String | Дополнительная информация об подписываемых данных | Текстовая строка. Возможно использовать HTML разметку. |
Ответ
Додаткова інформація про дані, що підписуються | Текстовий рядок. Можна використовувати HTML розмітку. |
Відповідь
Код відповідіКод ответа | Content-type | Допустимые параметры | Допустимі параметри | Приклад вмістуПример содержимого |
---|---|---|---|---|
200 | application/json | message | { | |
503 | application/json | message | { | |
400 | application/json | message | { |
...
Параметри JSON об'єкта відповіді
Параметр | Тип данныхданих | ОписаниеОпис |
---|---|---|
message | String | Описание результата проведения операции |
...
Опис результату проведення операції |
Приклад коду на JavaScript + jQuery 2.2.4
Code Block | ||
---|---|---|
| ||
$.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; } }) |
...