Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭЦП. Для внутреннего форматирования метаданных возможно использовать HTML разметку.
Данные сессии, для которых будут производиться операции ЭЦП и МБ, должны быть обязательно загружены перед установкой метаданных. Данные сессии отправляются в виде двоичных данных.
URL-адрес запроса
https://local.cipher.kiev.ua:9091/api/v1/ticket/{uuid}/metadatadata
Метод
PUTPOST
Параметры запроса
| uuid | String | Идентификатор сессии |
Настраиваемые заголовки запроса
| Content-Type | application/json |
Параметры JSON объекта запроса
| Имя | Тип | Описание | Допустимые значения |
|---|---|---|---|
| metaData | String | Дополнительная информация об подписываемых данных | Текстовая строка. Возможно использовать HTML разметку. |
| octet-stream |
Ответ
| Код ответа | Content-type | Допустимые параметры | Пример содержимого |
|---|---|---|---|
| 200 | application/json | message | { |
| 500503 | application/json | message | { |
| 400 | application/json | message | { "message" : "Сессия отсутствует." } |
| 500 | application/json | message failureCause | { "message" : "Данные сессии не были загружены перед установкой метаданныхОшибка при загрузке данных для сессии." "failureCause" : "" } |
| Параметр | Тип данных | Описание |
|---|---|---|
| message | String | Описание результата проведения операции |
| failureCause | String | Описание причины возникновения ошибки |
Пример кода на JavaScript + jQuery 2.2.4
| Code Block | ||
|---|---|---|
| ||
$.ajax({
url: "https://local.cipher.kiev.ua:9091/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/metadatadata",
type: "PUTPOST",
dataTypecontentType: "jsonapplication/octet-stream",
dataprocessData: JSON.stringify({metaData: "<h1>дополнительное описание</h1>"}) false,
data: rawData
}).done(function (jsonResponse, textStatus, xhr) {
message = jsonResponse.message;
}).fail(function (xhr) {
try {
var jsonResponse = JSON.parse(xhr.responseText);
message = jsonResponse.message;
failureCause = jsonResponse.failureCause;
} catch (e) {
message = (xhr.responseText == undefined) ? "Ошибка при установкезагрузке данных метаданныхсессии." : xhr.responseText;
}
}) |
...