Versions Compared

Old Version 8

changes.mady.by.user Svitlana Nimych

Saved on

compared with

New Version 9

changes.mady.by.user Svitlana Nimych

Saved on

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

Значення параметрів 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
Code Block
languagejs
 var 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;
    }
})

...