Запит ініціює запуск процесу генерації нових ключів. В процесу виконання запиту користувача за допомогою елементів керування відповідного діалогового вікна, необхідно вказати шлях до існуючого чи нового ключового контейнеру, а також пароль на ключовий контейнер та його підтвердження.

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

https://local.cipher.kiev.ua:9090/api/v1/generator/creator

Метод

POST

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

Відсутні

Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON обʼєкту запиту
ІмʼяТипОписДопустимі значення
NEW_KEY_TYPEStringТип ключа чи ключів, які генеруються

AGREEMENT - ключ звʼязку (шифрування), використовуваний для зашифрування даних
SIGNATURE - ключ електронного підпису
SIGNATURE_AND_AGREEMENT - ключ електронного підпису та ключ звʼязку

PROFILE_IDStringOID профіля сертифікатів

Значення параметру oid з профіля генерації ключів

PKCS10_DELIVERY_TYPEStringСпосіб доставки запиту(ів) на сертифікат

SEND_TO_PROXY - запит(и) будуть відправлені на вказаний у налаштуваннях Агента проксі сервер
RETURN_IN_RESPONSE - запит(и) будуть повернуті у параметрах JSON об`єкта відповіді

Значення за замовчуванням: SEND_TO_PROXY 
Значення за замовчуванням застосовується у разі відсутності параметра, якщо значення параметра null або пустий рядок.

Значення параметрів name обʼєкту з масиву fields профіля генерації ключів з oid = PROFILE_IDStringПараметри профіля генерації ключів з oid = PROFILE_ID

Залежить від параметру

Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/json
message
{
"message": "Ключі успішно згенеровані."
}
503application/jsonmessage
{
   "message" : "Сервіс зберігання даних не запущено."
}
500application/jsonmessage
failureCause 
{
   "message" : "Помилка при створенні файлу ключового контейнеру.",
"failureCause" : ""
}

{
"message": "Запит на генерацію ключів містить не всі обовʼязкові параметри.",
"failureCause": [
"EXTERNAL_USER_ID",
"UNZR"
]
}
400application/jsonmessage
{
   "message" : "Запит на генерацію ключів не містить JSON обʼєкта з додатковими даними."
}
Параметри JSON обʼєкта відповіді
Параметр
Тип даних
Опис
failureCause StringОпис причини виникнення помилки
failureCause ArrayМасив с ідентифікаторами відсутніх в об'єкті запиту обов'язкових параметрів
messageStringОпис результату проведення операції
signatureKeyPkcs10RequestString

Base64 рядок з даними запиту на сертифікат ключа підпису.

Увага

Параметр буде включений до об`єкта відповіді за умови, якщо NEW_KEY_TYPE= [SIGNATURE  або  SIGNATURE_AND_AGREEMENT] та PKCS10_DELIVERY_TYPE=RETURN_IN_RESPONSE.
agreementKeyPkcs10RequestString

Base64 рядок з даними запиту на сертифікат ключа звʼязку (шифрування).

Увага

Параметр буде включений до об`єкта відповіді за умови, якщо NEW_KEY_TYPE= [AGREEMENT або  SIGNATURE_AND_AGREEMENT] та PKCS10_DELIVERY_TYPE=RETURN_IN_RESPONSE.