1. Файловий контейнер
    Для використання в якості ключового контейнеру сесії завантажується файловий контейнер у кодуванні base64 у форматі PKCS#12, пропрієтарні формати ІІТ ("Key-6.dat", "Приватбанк jks", "Україна ZS2"). У випадку успішного завантаження при виконанні операції створення КЕП, зашифрування та розшифрування використовується особистий ключ, та за наявності сертифікат (ланцюг сертифікатів) із завантаженого файлового контейнеру.
    Дані ключового контейнеру сесії знаходяться в оперативній памʼяті з моменту завантаження до моменту видалення сесії та виконання віртуальною машиною Java наступної процедури збору сміття. Дані ключового контейнеру НІКОЛИ не зберігаються сервісом у файл, базу даних чи інші обʼєкти для довгострокового зберігання інформації. 
  2. Сховище ключів (токен) у складі хмарного сервісу.
    Підтримувані сервіси: Cipher-CKS, Depositsign

Увага

Метод підтримує захищені параметри. 
Ознайомитись с описом та деталями використання захищених параметрів можливо за посиланням Створення та використання захищених параметрів.
Усі параметри JSON обʼєкту запиту можуть бути передані як захищені параметри. Якщо відкритий параметр та захищений параметр мають однакове ім'я, то буде використане значення захищеного параметра.

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

https://ccs-dev-api.cipher.kiev.ua/ccs/api/v1/ticket/{uuid}/keyStore

Метод

PUT

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

Файловий контейнер у кодуванні Base64.

Не обовʼязковий параметр, який використовується лише при роботі з файловим контейнером. 

Правильно закодований Base64 рядок
keyStoreUriString

Унікальний ідентифікатор сховища ключів (токена).

Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами.

Формат залежить від хмарного сервісу, який згенерував URI
bearerTokenString

Токен доступу, який необхідний для доступу до API хмарного сервісу.

Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами.

Формат залежить від хмарного сервісу, який згенерував токен
privilegedBearerTokenString

Токен доступу, який використовується для виконання запитів без другого фактору, навіть якщо другий фактор ввімкнено в налаштуваннях облікового запису користувача.

Не обовʼязковий параметр, який використовується лише при роботі з деякими хмарними сервісами.

Лише для хмарного сервісу Depositsign
Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/jsonmessage
{
   "message" : "Дані ключового контейнеру успішно завантажено.",
}
503application/jsonmessage
{
   "message" : "Сервіс зберігання даних не запущено."
}
400application/jsonmessage
{
   "message" : "Сесія відсутня."
}
500application/jsonmessage
failureCause 
{
   "message" : "Помилка при завантаженні даних ключового контейнеру.",
"failureCause" : ""
}
Параметри JSON обʼєкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції
failureCause StringОпис причини появи помилки