Запит ініціює запуск процесу генерації нових ключів. В процесу виконання запиту користувача за допомогою елементів керування відповідного діалогового вікна, необхідно вказати шлях до існуючого чи нового ключового контейнеру, а також пароль на ключовий контейнер та його підтвердження.
URL-адреса запиту
https://local.cipher.kiev.ua:9090/api/v1/generator/creator
Метод
POST
Параметри запиту
Відсутні
Налаштовувані заголовки запиту
Content-Type | application/json |
Параметри JSON обʼєкту запиту
Імʼя | Тип | Опис | Допустимі значення |
---|---|---|---|
NEW_KEY_TYPE | String | Тип ключа чи ключів, які генеруються | AGREEMENT - ключ звʼязку (шифрування), використовуваний для зашифрування даних |
PROFILE_ID | String | OID профіля сертифікатів | Значення параметру oid з профіля генерації ключів |
PKCS10_DELIVERY_TYPE | String | Спосіб доставки запиту(ів) на сертифікат | SEND_TO_PROXY - запит(и) будуть відправлені на вказаний у налаштуваннях Агента проксі сервер RETURN_IN_RESPONSE - запит(и) будуть повернуті у параметрах JSON об`єкта відповіді |
Значення параметрів name обʼєкту з масиву fields профіля генерації ключів з oid = PROFILE_ID | String | Параметри профіля генерації ключів з oid = PROFILE_ID | Залежить від параметру |
Відповідь
Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
---|---|---|---|
200 | application/json | message | { |
503 | application/json | message | { |
500 | application/json | message failureCause | { |
400 | application/json | message | { |
Параметри JSON обʼєкта відповіді
Параметр | Тип даних | Опис |
---|---|---|
failureCause | String | Опис причини виникнення помилки |
failureCause | Array | Масив з ідентифікатортами відсутні обовʼязкових параметрів |
message | String | Опис результату проведення операції |
signatureKeyPkcs10Request | String | Base64 рядок з даними запиту на сертифікат ключа підпису. |
agreementKeyPkcs10Request | String | Base64 рядок з даними запиту на сертифікат ключа звʼязку (шифрування). |
Приклад коду на JavaScript + jQuery 2.2.4
var keyGenerationData = { "NEW_KEY_TYPE" : "SIGNATURE", "PROFILE_ID" : "1.3.6.1.4.1.7845.2.1.12.3", "COMMON_NAME" : "Тестовий 14", "COUNTRY_NAME" : "ua", "GIVEN_NAME" : "Імʼя, по батькові", "LOCALITY_NAME" : "Харків", "STATE_OR_PROVINCE_NAME" : "Харківська", "STREET_ADDRESS" : "пр. Науки, 7", "SURNAME" : "Прізвище", "TITLE" : "Посада", "ORGANIZATION_NAME" : "Організація", "ORGANIZATIONAL_UNIT_NAME" : "Підрозділ", "DRFOU" : "121212", "PASSPORT" : "KH123447", "MAIL" : "test@cipher.com", "UNZR" : "01010101010115", "EXTERNAL_USER_ID" : "001" }; $.ajax({ url: "https://local.cipher.kiev.ua:9090/api/v1/generator/creator", type: "POST", dataType: "json", contentType: "application/json", data: JSON.stringify(keyGenerationData) }).done(function (jsonResponse, textStatus, xhr) { message = jsonResponse.message; }).fail(function (xhr) { try { var jsonResponse = JSON.parse(xhr.responseText); message = jsonResponse.message; failure = jsonResponse.failureCause; } catch (e) { message = (xhr.responseText == undefined) ? "Помилка в процесі генерації ключів." : xhr.responseText; } })