Запит дозволяє ініціювати процес використання особистих ключів при виконанні Сервісом відповідних операцій. Функціональність аналогічна наданому інтерфейсом Сервісу, відмінність лише в способі надання даних. У випадку використання інтерфейсу користувача, шлях до ключового контейнеру, пароль до ключового контейнеру, використовуваний Кваліфікований надавач електронних довірчих послуг (КНЕДП) та за необхідності, сертифікат ключа вказується у відповідному елементі управління, а при використанні REST API вказані вище дані передаються у вигляді JSON об'єкта.

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

Запит не буде виконано. якщо Сервіс вже використовує особисті ключі. Для завершення використання особистих ключів за допомогою REST API, необхідно використовувати запит Завершення використання особистих ключів.

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

https://local.cipher.kiev.ua:9091/api/v1/personalKeysSession

Метод

POST

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

Відсутні

Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON об'єкта відповіді
Ім'яТипОписДопустимі значення
keyStorageString

Шлях до ключового контейнеру чи пін-код до захищеного носія

Для файлового контейнеру поле має містити діючий шлях до файлу з ключовим контейнером.
Для захищеного носія поле має містити спеціальний ідентифікатор підключеного до хосту захищеного носія. Для отримання спеціальних ідентифікаторів, які відповідають підключенним до хосту захищеним носіям, необхідно використовувати запит Отримання списку підключених захищених носіїв.
keyStoragePasswordStringПароль до ключового контейнеру
cartificatePathStringшлях до файлу з сертифікатом ключа, який знаходиться в ключовому контейнері
caIdStringІдентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеру

Ідентифікатори підтримуваних сервісом КНЕДП, необхідно попередньо отримати за допомогою запиту Отримання списку підтримуваних КНЕДП.

Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/json

message

{
    "message": "Запит на використання особистих ключів виконано."
}
503application/jsonmessage
{
    "message" : "Сервіс зберігання не запущено." 
}
400application/jsonmessage
{
    "message" : "Запит на містить JSON об'єкта з додатковими даними." 
}
500application/jsonmessage
failureCause
{
    "message": "Запит на використання особистих ключів не виконано.",
    "failureCause": "Персональний сервіс вже використовує особисті ключі. Завершіть їх використання."
}

{
    "message": "Запит на використання особистих ключів не виконано.",
    "failureCause": [
        "Не вдалося створити криптографічний контекст",
        "Помилка завантаження ключового контейнеру."
     ]
}
Параметри JSON об'єкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції

failureCause 

StringОпис причини виникнення помилки
failureCause ArrayОпис причини виникнення помилки (помилок)