Створення розширення на використання ЕП

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

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

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

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

https://local.cipher.kiev.ua:9091/api/v1/accessToken

Метод

POST

Параметри запиту

Відсутні

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

Content-Type

application/json

Параметри JSON об'єкта запиту

Ім'я	Тип	Опис	Допустимі значення
accessTimesNumber	Number	Кількість раз використання ЕП, на яку буде запрошено розширення у користувача.
metaData	String	Додаткова інформація про підписуванні дані.	Текстовий рядок. Можна використовувати HTML розмітку.
prefViewWidth	Number	Ширина діалогового вікна, в якому буде розміщена додаткова інформація про підписані дані.
prefViewHeight	Number	Висота діалогового віна, в якому розміщується додаткова інформація про підписувані дані.

Відповідь

Код відповіді	Content-type	Допустимі параметри	Приклад вмісту
200	application/json	message	{ "message" : "Запит на використання ЕП успішно оброблений. Кількість спроб: 2.", "accessTokenUuid" :"85a3bdd5-9b5e-4bc6-8e7b-447a583b7139" }
403	application/json	message	{ "message" : "Запит на використання ЕП відхилено користувачем." }
400	application/json	message	{ "message" : "Запит на використання ЕП містить неправильний формат параметру "accessTimesNumber"." }
503	application/json	message	{ "message" : "Сервіс зберігання даних не запущено." }

Параметри JSON об'єкта відповіді

Параметр	Тип даних	Опис
message	String	Опис результату проведення операції
accessTokenUuid	String	Ідентифікатор створеного розширення

Приклад коду на JavaScript + jQuery 2.2.4

$.ajax({
    url: "https://local.cipher.kiev.ua:9091/api/v1/accessToken",
    type: "POST",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify({accessTimesNumber: 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;
    }
})

Page tree