При получении запроса на выработку ЭЦП Сервис посредством диалогового окна запрашивает у пользователя разрешение на использование ЭЦП. Разрешение действительно в рамках одного запроса. В случае получения Сервисом запроса на создание разрешения на использование ЭЦП Сервис посредством диалогового окна запрашивает у пользователя разрешение на использование ЭЦП некоторое количество раз.
Для работы с разрешением используется 128-битное значение вида xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, где x-цифра(буква) шеснадцатиричной системы счисления.
Разрешение может использоваться как в одной так и в нескольких сессиях.Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭЦП. Для внутреннего форматирования метаданных возможно использовать HTML разметку.
Данные сессии, для которых будут производиться операции ЭЦП и МБ, должны быть обязательно загружены перед установкой метаданных.
URL-адрес запроса
https://local.cipher.kiev.ua:9091/api/v1/ticket/{uuid}/metadataaccessToken
Метод
PUTPOST
Параметры запроса
...
Отсутствуют
...
Настраиваемые заголовки запроса
...
Параметры JSON объекта запроса
| Имя | Тип | ОписаниеДопустимые значения | |
|---|---|---|---|
accessTimesNumber | |||
| metaData | String | Дополнительная информация об подписываемых данных | Текстовая строка. Возможно использовать HTML разметку. |
| Number | Количество раз использования ЭЦП, на которые будет запрошено разрешение у пользователя |
Ответ
| Код ответа | Content-type | Допустимые параметры | Пример содержимого |
|---|---|---|---|
| 200 | application/json | message | { "message" :"Метаданные для сессии успешно загружены "Запрос на использование ЭЦП успешно обработан. Количество попыток: 2.", |
| 503403 | application/json | message | {"Сервис выполнения криптографических операций не запущен." "Запрос на использование ЭЦП отклонен пользователем." |
| 400 | application/json | message | { |
| 503 | application/json | message | {"Данные сессии не были загружены перед установкой метаданных ." |
Параметры JSON объекта ответа
| Параметр | Тип данных | Описание |
|---|---|---|
| message | String | Описание результата проведения операции |
| accessTokenUuid | String | Идентификатор созданного разрешения |
Пример кода на JavaScript + jQuery 2.2.4
| Code Block | ||
|---|---|---|
| ||
$.ajax({
url: "https://local.cipher.kiev.ua:9091/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/metadataaccessToken",
type: "PUTPOST",
dataType: "json",
contentType: "application/json",
data: JSON.stringify({metaDataaccessTimesNumber: "<h1>дополнительное описание</h1>"2})
}).done(function (jsonResponse, textStatus, xhr) {
message = jsonResponse.message;
accessTokenUuid = jsonResponse.accessTokenUuid;
}).fail(function (xhr) {
try {
var jsonResponse = JSON.parse(xhr.responseText);
message = jsonResponse.message;
} catch (e) {
message = (xhr.responseText == undefined) ? "Ошибка при установке метаданных получении разрешения на использование ЭЦП." : xhr.responseText;
}
}) |
...