Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  1. Файловий контейнер
    Для

...

  1. використання в якості ключового контейнеру сесії завантажується файловий контейнер у кодуванні base64 у форматі PKCS#12, пропрієтарні формати ІІТ ("Key-6.dat", "Приватбанк jks", "

...

  1. Україна ZS2").

...

Путь к аппаратному носителю с поддержкой PKCS#11, который подключен к компьютеру, на котором выполняется сервис, необходимо получить посредством запроса https://docs.cipher.kiev.ua/x/GYOD.

Если в запросе одновременно присутствуют данные файлового ключевого контейнера и путь к ключевому контейнеру, то будет использован только путь.

Если отдельными запросами для сессии были загружены и данные файлового контейнера, и путь к ключевому контейнеру, то будет использован только путь.

Данные ключевого контейнера сессии находятся в оперативной памяти с момента загрузки до момента удаления сессии и выполнения виртуальной машиной Java последующей процедуры сборки мусора. Данные ключевого контейнера НИКОГДА не сохраняются сервисом в файл, базу данных или другие объекты для долгосрочного хранения информации.  

URL-адрес запроса
  1. У випадку успішного завантаження при виконанні операції створення КЕП, зашифрування та розшифрування використовується особистий ключ, та за наявності сертифікат (ланцюг сертифікатів) із завантаженого файлового контейнеру.
    Дані ключового контейнеру сесії знаходяться в оперативній памʼяті з моменту завантаження до моменту видалення сесії та виконання віртуальною машиною Java наступної процедури збору сміття. Дані ключового контейнеру НІКОЛИ не зберігаються сервісом у файл, базу даних чи інші обʼєкти для довгострокового зберігання інформації. 
  2. Сховище ключів (токен) у складі хмарного сервісу.
    Підтримувані сервіси: Cipher-CKS, Depositsign
Note
titleУвага

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

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

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

Метод

PUT

...

Параметри запиту
uuidString
Идентификатор сессии
Ідентифікатор сесії

...

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

...

запиту
Content-Typeapplication/json

...

Параметри JSON

...

обʼєкту запиту
Имя
Імʼя
Тип
Описание
Опис
Допустимые значения
Допустимі значення
base64Data
String
Файловый

Файловий контейнер

в кодировке Base64Правильно закодированная Base64 строкаkeyStorePathString

Путь в специальном формате к файловому контейнеру или аппаратному носителю с поддержкой PKCS#11

Для получения списка подключенных аппаратных носителей необходимо использовать запрос
Ответ

у кодуванні Base64.

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

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

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

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

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

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

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

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

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

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

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

...

Параметри JSON

...

обʼєкта відповіді
ПараметрТип
данных
даних
Описание
Опис
messageString
Описание результата проведения операции
Опис результату проведення операції
failureCause String
Описание причины возникновения ошибки
Пример кода на JavaScript + jQuery 2.2.4 в случае использования аппаратного носителя в активном режиме
Code Block
languagejs
var data = {
    keyStorePath: "@. Avtor SecureToken 0"
}
$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/keyStore",
    type: "POST",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(data)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при загрузке данных ключевого контейнера." : xhr.responseText;
    }
})
Пример кода на JavaScript + jQuery 2.2.4 в случае использования файлового контейнера с указанием пути
Code Block
languagejs
var data = {
    keyStorePath: "z:\\sharedFiles\\temp\\7\\Molyakov_overdue-DS+Arg.pfx"
}
$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/keyStore",
    type: "POST",
    dataType: "json",
    contentType: "application/json",
    data: JSON.stringify(data)
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при загрузке данных ключевого контейнера." : xhr.responseText;
    }
})
Пример кода на JavaScript + jQuery 2.2.4 в случае использования данных файлового контейнера

...

languagejs

...

Опис причини появи помилки