Запит ініціює запуск процесу генерації нових ключів. В процесу виконання запиту користувача за допомогою елементів керування відповідного діалогового вікна, необхідно вказати шлях до існуючого чи нового ключового контейнеру, а також пароль на ключовий контейнер та його підтвердження.
URL-адреса запиту
Запрос инициирует запуск процесса генерации новых ключей. В процессе выполнения запроса пользователю посредством элементов управления соответствующего диалогового окна необходимо указать путь к существующему или новому ключевому контейнеру, а также пароль на ключевой контейнер и его подтверждение.
...
https://local.cipher.kiev.ua:9090/api/v1/generator/creator
Метод
POST
...
Параметри запиту
ОтсутствуютВідсутні
...
Налаштовувані заголовки
...
запиту
| Content-Type | application/json |
...
Параметри JSON
...
обʼєкту запиту
ИмяОписаниеДопустимые значения| Допустимі значення |
|---|
| NEW_KEY_TYPE | String | Тип |
генерируемого ключа или ключей.| ключа чи ключів, які генеруються | AGREEMENT - ключ |
связи, используемый для шифрования данныхзвʼязку (шифрування), використовуваний для зашифрування даних
SIGNATURE - |
ключ цифровой подписиключ електронного підпису
SIGNATURE_AND_AGREEMENT - ключ |
цифровой подписи и ключ связиелектронного підпису та ключ звʼязку |
| PROFILE_ID | String | OID |
профиля сертификатовЗначение параметра oid из профиля генерации ключей | Значения параметров name объекта из массива fields профиля генерации ключей с oid равным | профіля сертифікатів | Значення параметру oid з профіля генерації ключів |
| PKCS10_DELIVERY_TYPE | String | Спосіб доставки запиту(ів) на сертифікат | SEND_TO_PROXY - запит(и) будуть відправлені на вказаний у налаштуваннях Агента проксі сервер
RETURN_IN_RESPONSE - запит(и) будуть повернуті у параметрах JSON об`єкта відповіді Значення за замовчуванням: SEND_TO_PROXY
Значення за замовчуванням застосовується у разі відсутності параметра, якщо значення параметра null або пустий рядок. |
| Значення параметрів name обʼєкту з масиву fields профіля генерації ключів з oid = PROFILE_ID | String | Параметри |
профиля генерации ключей с oid равным | профіля генерації ключів з oid = PROFILE_ID |
Зависит от параметра | ...
Відповідь
ответа| Допустимые параметры | Пример содержимого| Допустимі параметри | Приклад вмісту |
|---|
| 200 | application/json | message | {
"message": " |
Ключиуспешносгенерированызгенеровані."
} |
| 503 | application/json | message | {
|
Сервисхраненияданныхзапущензапущено."
} |
| 500 | application/json | message
failureCause | {
|
Ошибкасозданиифайлаключевогоконтейнераконтейнеру.",
"failureCause" : ""
}
{
"message": " |
Запросгенерациюключейсодержитвсеобязательныепараметры ]
} |
| 400 | application/json | message | {
|
Запросгенерациюключейсодержитобъектасдополнительнымиданными ...
Параметри JSON
...
обʼєкта відповіді
данныхОписаниеОписание причины возникновения ошибки| Опис причини виникнення помилки |
| failureCause | Array |
Массив с идентификаторами отсутствующих обязательных параметров| Масив с ідентифікаторами відсутніх в об'єкті запиту обов'язкових параметрів |
| message | String |
Описание результата проведения операции | Пример кода на JavaScript + jQuery 2.2.4
...
...
| Опис результату проведення операції |
| signatureKeyPkcs10Request | String | Base64 рядок з даними запиту на сертифікат ключа підпису. | Note |
|---|
| | Параметр буде включений до об`єкта відповіді за умови, якщо NEW_KEY_TYPE= [SIGNATURE або SIGNATURE_AND_AGREEMENT] та PKCS10_DELIVERY_TYPE=RETURN_IN_RESPONSE. |
|
| agreementKeyPkcs10Request | String | Base64 рядок з даними запиту на сертифікат ключа звʼязку (шифрування). | Note |
|---|
| | Параметр буде включений до об`єкта відповіді за умови, якщо NEW_KEY_TYPE= [AGREEMENT або SIGNATURE_AND_AGREEMENT] та PKCS10_DELIVERY_TYPE=RETURN_IN_RESPONSE. |
|
...