Versions Compared

Old Version 1

changes.mady.by.user Alexandr Stokipny

Saved on

compared with

New Version Current

changes.mady.by.user Svitlana Nimych

Saved on

Key

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

Доступно лише в версії Enterprise.

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

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

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

...

https://local.cipher.kiev.ua:9091/api/v1/generator/creator

Метод

POST

...

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

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

...

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

...

запиту
Content-Typeapplication/json
Параметры JSON объекта запроса
Параметри JSON об'єкта запиту
Ім'я
Имя
Тип
Описание
Опис
Допустимые значения
Допустимі значення
NEW_KEY_TYPEStringТип
генерируемого ключа или ключей
ключа чи ключів, які генеруються.

AGREEMENT - ключ

связи, используемый для шифрования данных

зв'язку, який використовується для шифрування даних
SIGNATURE -

 ключ цифровой подписи

ключ електронного підпису
SIGNATURE_AND_AGREEMENT - ключ

цифровой подписи и ключ связи

електронного підпису та зв'язку (шифрування)

PROFILE_IDStringOID
профиля сертификатовЗначение параметра oid из профиля генерации ключейЗначения параметров name объекта
из массива fields профиля генерации ключей
с oid равным
профія сертифікатівЗначення параметру oid з профілю генерації ключів
Значення параметрів name об'єкта з масиву fields профіля генерації ключів з oid, який = PROFILE_IDStringПараметри
профиля генерации ключей с 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

...

Масив з ідентифікаторами, де відсутні обов'язкові параметри
messageStringОпис результату проведення операції