Versions Compared

Key

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

...

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

https://localhost:9094/api/v1/ticket/{uuid}/keyStore

Метод

PUT

...

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

...

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

...

запиту
Content-Typeapplication/json

...

Параметри JSON

...

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

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

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

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

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

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

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

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

Необязательный параметр, используется только при работе с некоторыми облачными сервисами.

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

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

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

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

Необязательный параметр, используется только при работе с некоторыми облачными сервисами.

Только для облачного сервиса Depositsign
Ответ

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

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

Лише для хмарного сервісу Depositsign
Відповідь
Код відповідіКод ответа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
var settings = {
  "url": "https://localhost:9094/api/v1/ticket/32cec449-9857-4ace-aaa4-b8c2c507e1d2/keyStore",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{token}}"
  },
  "data": JSON.stringify({
    "base64Data": "MIIE4wIBAzCCBIAGCSqGSIb3DQEHAaCCBHEEggRtMIIEaTCCBGUGCSqGSIb3DQEHAaCCBFYEggRSMIIETjCCAfIGCyqGSIb3DQEMCgECoIIBrjCCAaowgbAGCSqGSIb3DQEFDTCBojBDBgkqhkiG9w0BBQwwNgQgHjNPbWQsQ9UK3CR6wfTZdvuwtDW0So6Dny2fpdXUvG0CAicQMA4GCiqGJAIBAQEBAQIFADBbBgsqhiQCAQEBAQEBAzBMBAhAIS5+Hm6tHQRAqdbrRfE8cIKAxJZ7Ix9erfZY66TANykdONlr8CXKThf46XINxhW0OiiXXwvB3qNkOLVk6iwXn9ASPm24+sV5BASB9LwokywZbaJhIpOjNnVNW6SQNil5ghgfaqeF2kIYrsi7UYjq5SpNSxY3/9g8Y/9z1AcB6NyKEqzAsrU1v1mnv1j4S2uw4ynTbsSY5KPi3w4x9DjTdWya0Cn5e7RJ7+Szhcc8zvqXB2KqCe4qdzcrbLe0KgNcNDIwIE+dZLOj7KLYIR8a8cw5+KhI90FSuEfvReAlZqgjtSV7IECbJHlyF0Cq2EdCJ9CDtV7m3GS61KdlrXIpWnd3a7g0A0Kvd9CQXoi3sjl3SJ+Xh7S6DNzRykRWuHe+jPzGS0IYjpqtFOpAOjxjn2W3VAQw/IBQW4po1E+mmE8xMTAvBgkqhkiG9w0BCRUxIgQgBBb7wFVMJwq8Y1yG6SDgtkOQSDOHqo8cYuTcnIRRepkwggJUBgsqhkiG9w0BDAoBAqCCAhAwggIMMIGwBgkqhkiG9w0BBQ0wgaIwQwYJKoZIhvcNAQUMMDYEIKUx0CFQ4n7040lVjWvZlNQvALlgujsSZvtWbtNE7AWlAgInEDAOBgoqhiQCAQEBAQECBQAwWwYLKoYkAgEBAQEBAQMwTAQIKYyhwjLgbWYEQKnW60XxPHCCgMSWeyMfXq32WOukwDcpHTjZa/Alyk4X+OlyDcYVtDool18Lwd6jZDi1ZOosF5/QEj5tuPrFeQQEggFVxHMEdMa0ooGKEMkYMjFVHf2LYhwcwk4r0/wr7/hihmqdde1GN6UGVMr0/jrYYLHE0uJsOyqVc0/nXF6L1wycqbCnGxxwL48QdQDz6j4D7pIoN21c5c2kFYqZjxi5g73kctLeR0skqqu+pD2vxpsW7fkJhTdVgdxTFNM1JBgC2O5XBEcT3BUP90omF2X3NZL4n/j3L1X3lePjnffVIH0ThLMowEkBo2sxg4iGJeRD9xshpvJqgy8wq3KSy3Tp9Ph7Tb3Akecvxl13Yu80gRku8ZdWvHdsMMMoMPaO6Jp/+41RqqH7xGJwL7nAv4K7w3VATvwvISKXwNwRPRSL7gzZtUE+iqtQG7o8+LbtV29LPLTIC0G2UpT3RIRYExc0CZYXcPk0QtjM5NutqdvI5Gmw8e48hz+/tqtUXKzAKwzIRqagfPS4nApu1y6uZwl8ry3EuGnkrU4xMTAvBgkqhkiG9w0BCRUxIgQgQ3nRbUNM+XnKILpt5dwLfZPDC6X382vd+mYygooG59wwWjAyMA4GCiqGJAIBAQEBAgEFAAQg4kDtDBXfZMoOhoeLysS157OaRYC8N9Nc21xp5uEP77AEIH8jII3jRSetdi1iVrO0oJ9i6C1rPK7ischqsqzLCS1TAgInEA=="
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
Depositsign
Code Block
languagejs
var settings = {
  "url": "https://localhost:9094/api/v1/ticket/86e81068-aa67-47ff-98b3-cc226a9147c0/keyStore",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "keyStoreUri": "93fd72ec-55f6-4985-8216-6eb112d99508",
    "bearerToken": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTUxMiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjQyOTliODQyLWVhOWMtNGJhMy04ZTZmLWFiZWUxMmE5MDcyMCIsImh0dHA6Ly9zY2hlbWFzLnhtbHNvYXAub3JnL3dzLzIwMDUvMDUvaWRlbnRpdHkvY2xhaW1zL25hbWUiOiJ0ZXN0RFMiLCJuYmYiOjE2MTA2OTc3MTAsImV4cCI6MTYxMDc4NDExMCwiaXNzIjoiaHR0cDovL2RlcG9zaXRzaWduLmNvbSIsImF1ZCI6Imh0dHA6Ly9kZXBvc2l0c2lnbi5jb20ifQ.vwosOK_5WzWtjymN-ZDdR_5EZ7dNZyOkGbAhh17V9xtJyLOv5xJFXD_udZROzrpaj0uVcMb0867tuNkQG6-om"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

...