Versions Compared

Key

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

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

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

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

...

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

Метод

POST

...

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

ОтсутствуютВідсутні

...

Налаштовувані заголовки

...

запиту
Content-Typeapplication/json

...

Параметри JSON

...

обʼєкта запиту
Имя
ІмʼяТип
Описание
Опис
Допустимые значенияAGREEMENT - ключ связи, используемый для шифрования данных
SIGNATURE - ключ электронной подписи
Допустимі параметри
NEW_KEY_TYPEStringТип
генерируемого ключа или ключей.
ключа чи ключів, які генеруються AGREEMENT - ключ звʼязку (шифрування), використовуваний для зашифрування даних
SIGNATURE - ключ електронного підпису

SIGNATURE_AND_AGREEMENT - ключ
электронной подписи и ключ связи
електронного підпису та ключ звʼязку
PROFILE_IDStringOID
профиля сертификатовЗначение параметра oid из профиля генерации ключейТекстовая строкаЗначения параметров name объекта
из массива fields профиля генерации ключей
с oid равным
профіля сертифікатів

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

TRANSPORT_CONTAINER_PASSWORDStringПароль на PKCS#12 контейнер,
который будет возвращен как результат запроса
який буде повернено як результат запитуТекстовий рядок
Значення параметрів name обʼєкта
з масиву fields пофіля генерації ключів з oid =
PROFILE_IDString
Параметры профиля генерации ключей с oid равным
Параметри профіля генерації ключів з oid = PROFILE_ID
Зависит от параметра

...

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

Відповідь
Код
ответа
відповідіContent-type
Допустимые параметрыПример содержимого
Допустимі параметриПриклад вмісту
200application/json
message
{
"message": "
Ключи
Ключі 
успешно
успішно 
сгенерированы
згенеровані.",
"base64TransportContainer": " ... "
}
503application/jsonmessage
{
   
    "message" : "
Сервис
Сервіс 
хранения
зберігання 
данных
даних не 
запущен
запущено." 
}
500application/jsonmessage
failureCause 
{
   
    "message" : "
Ошибка
Помилка при 
создании
створенні 
файла
файлу 
ключевого
ключового 
контейнера
контейнеру.",
"failureCause" : ""
}
{
"message": "
Запрос
Запит на 
генерацию
генерацію 
ключей
ключів 
содержит
містить не 
все
всі 
обязательные
обовʼязкові 
параметры
параметри.",
"failureCause": [
"EXTERNAL_USER_ID",
"UNZR"
]
}
400application/jsonmessage
{
   
    "message" : "
Запрос
Запит на 
генерацию
генерацію 
ключей
ключів не 
содержит
містить JSON 
объекта
обʼєкта 
с
з 
дополнительными
додатковими 
данными
даними." 
}

...

Параметри JSON

...

обʼєкту відповіді
Параметр
Тип
данных
даних
Описание
Опис
failureCause String
Описание причины возникновения ошибки
Опис причини виникнення помилки
failureCause Array
Массив с идентификаторами отсутствующих обязательных параметров
Масив з ідентифікаторами відсутніх обовʼязкових параметрів
messageString
Описание результата проведения операции
Опис результату проведення операції
base64TransportContainerStringКонтейнер PKCS#12
с запросом
із запитом(ами) PKCS#10
в формате base64
Пример кода на JavaScript + jQuery 2.2.4

...

languagejs

...

у форматі base64