Установка метаданных сессии

Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭП. Для внутреннего форматирования метаданных возможно использовать 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;
    }
})

Page tree