Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

У випадку отримання Сервісом запиту на створення розширення на використання ЕП, Сервіс за допомогою діалогового вікна запитує у користувача розширення на використання ЕП деяку кількість разів.  

Для роботи з розширенням використовується 128-бітне значення виду xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, де x-цифра(буква) шістнадцятирічної системи числення.

Розширення може використовуватися як в рамках однієї так і кількох сесій.

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

Метаданные используются для предоставления пользователю дополнительной информации в случае запроса на разрешение использования ЭЦП. Для внутреннего форматирования метаданных возможно использовать HTML разметку.
Данные сессии, для которых будут производиться операции ЭЦП и МБ, должны быть обязательно загружены перед установкой метаданных. 

...

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

Метод

PUTPOST

...

Параметри запиту
uuidStringИдентификатор сессии

Відсутні

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

...

Content-Typeapplication/json
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'яТипОписДопустимі значення

accessTimesNumber

NumberКількість раз використання ЕП, на яку буде запрошено розширення у користувача.
ИмяТипОписаниеДопустимые значения

metaData

String
Дополнительная информация об подписываемых данныхТекстовая строка. Возможно использовать HTML разметку.
Ответ
Додаткова інформація про підписуванні дані.Текстовий рядок. Можна використовувати HTML розмітку.

prefViewWidth

NumberШирина діалогового вікна, в якому буде розміщена додаткова інформація про підписані дані.

prefViewHeight

NumberВисота діалогового віна, в якому розміщується додаткова інформація про підписувані дані.
Відповідь
Код відповіді
Код ответа
Content-type
Допустимые параметрыПример содержимого
Допустимі параметриПриклад вмісту
200application/jsonmessage
{
   
    "message" :
"Метаданные для сессии успешно загружены.",
}
 "Запит на використання ЕП успішно оброблений. Кількість спроб: 2.",
"accessTokenUuid" :"85a3bdd5-9b5e-4bc6-8e7b-447a583b7139"
}
403
503
application/jsonmessage
{
   
    "message" :
"Сервис выполнения криптографических операций не запущен."
 "Запит на використання ЕП відхилено користувачем." 
}
400application/jsonmessage
{
   
    "message"
: "Данные сессии не были загружены перед установкой метаданных."
}
Параметры JSON объекта ответа
ПараметрТип данныхОписание
messageStringОписание результата проведения операции
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

 

...

: "

...

Запит на використання ЕП містить неправильний формат параметру "accessTimesNumber"." 
}
503application/jsonmessage
{
   "message" : "Сервіс зберігання даних не запущено."
}
Параметри JSON об'єкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції
accessTokenUuidStringІдентифікатор створеного розширення
Приклад використання HTML розмітки для відображення додаткової інформації при створенні розширення на використання ЕП.