Versions Compared

Key

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

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

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 из профиля генерации ключей

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

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

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

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

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

Значення параметрів name обʼєкту з масиву fields профіля генерації ключів з oid = Значения параметров name объекта
из массива fields профиля генерации ключей
с oid равным PROFILE_ID
StringПараметри профиля генерации ключей с oid равным профіля генерації ключів з 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Описание результата проведения операции
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

Опис результату проведення операції
signatureKeyPkcs10RequestString

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

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


agreementKeyPkcs10RequestString

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

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

...