Запит дозволяє ініціювати процес використання особистих ключів при виконанні Сервісом відповідних операцій. Функціональність аналогічна наданому інтерфейсом Сервісу, відмінність лише в способі надання даних. У випадку використання інтерфейсу користувача, шлях до ключового контейнеру, пароль до ключового контейнеру, використовуваний Кваліфікований надавач електронних довірчих послуг (КНЕДП) та за необхідності, сертифікат ключа вказується у відповідному елементі управління, а при використанні REST API вказані вище дані передаються у вигляді JSON об'єкта.
У випадку успішного виконання запиту сервіс починає використовувати особисті ключі, інтерфейс користувача починає відображати інформацію із сертифікату ключа та доступні користувачу дії.
Запит не буде виконано. якщо Сервіс вже використовує особисті ключі. Для завершення використання особистих ключів за допомогою REST API, необхідно використовувати запит Завершення використання особистих ключів.
URL-адреса запиту
Запрос позволяет инициировать процесс использования личных ключей пользователя при выполнении Сервисом соответствующих операций. Функциональность аналогична предоставляемой пользовательским интерфейсом Сервиса, отличие лишь в способе предоставления данных. В случае использования интерфейса пользователя, путь к ключевому контейнеру, пароль к ключевому контейнеру, использоемый ЦСК и, при необходимости, сертификат ключа вводятся в соответствующие элементы управления, а при использовании REST API указанные выше данные передаются в виде JSON объекта.
В случае успешного выполнения запроса сервис начинает использовать личные ключи, интерфейс пользователя начинает отображать информацию из сертификата ключа и доступные пользователю действия.
Запрос не будет выполнен, если Сервис уже использует личные ключи. Для завершения использования личных ключей посредством REST API необходимо использовать запрос Завершение использования личных ключей.
...
https://local.cipher.kiev.ua:9091/api/v1/personalKeysSession
Метод
POST
...
Параметри запиту
ОтсутствуютВідсутні
...
Налаштовувані заголовки
...
запиту
| Content-Type | application/json |
Параметры JSON объекта запроса
Параметри JSON об'єкта відповіді
ИмяОписаниеДопустимые значения| Допустимі значення |
|---|
| keyStorage | String |
Путь к ключевому контейнеру или к защищенному носителю.Шлях до ключового контейнеру чи пін-код до захищеного носія | Для файлового |
контейнера поле должно содержать действительный путь к файлу с ключевым контейнеру поле має містити діючий шлях до файлу з ключовим контейнером.
Для |
защищенного носителя поле должно содержать специальный идентификатор подключенного к хосту защищенного носителя. Для получения списка специальных идентификаторов, которые соответствуют подключенным к хосту защищенным носителям, необходимо использовать запрос Получение списка подключенных защищенных носителей. | захищеного носія поле має містити спеціальний ідентифікатор підключеного до хосту захищеного носія. Для отримання спеціальних ідентифікаторів, які відповідають підключенним до хосту захищеним носіям, необхідно використовувати запит Отримання списку підключених захищених носіїв. |
| keyStoragePassword | String | Пароль |
к ключевому Путь к файлу с сертификатом | | шлях до файлу з сертифікатом ключа, |
который находится в ключевом контейнере| який знаходиться в ключовому контейнері |
|
Идентификатор (А)ЦСК, который издал сертификат ключа из ключевого контейнера. Идентификаторы поддерживаемых Сервисом (А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых (А)ЦСК | | Ответ
| Ідентифікатор КНЕДП, який видав сертифікат ключа з ключового контейнеру | Ідентифікатори підтримуваних сервісом КНЕДП, необхідно попередньо отримати за допомогою запиту Отримання списку підтримуваних КНЕДП. |
Відповідь
Код ответа| Допустимые параметры | Пример содержимого| Допустимі параметри | Приклад вмісту |
|---|
| 200 | application/json | message | {
"message": " |
Запросиспользованиеличныхключейвыполненвиконано."
} |
| 503 | application/json | message | {
|
Сервисхраненияданных запущензапущено."
} |
| 400 | application/json | message | {
|
Запроснесодержитобъектасдополнительнымиданнымиданими."
} |
| 500 | application/json | message
failureCause | {
"message": " |
Запросиспользованиеличныхключейвыполненвиконано.",
"failureCause": " |
ПерсональныйсервисужеиспользуетличныеключиЗавершитеихиспользованиевикористання."
}
{
"message": " |
Запросиспользованиеличныхключейвыполненвиконано.",
"failureCause": [
" |
Невозможносоздатькриптографическийкриптографічний контекст",
"Помилка завантаження ключового |
контейнера ...
Параметри JSON об'єкта відповіді
данныхОписаниеОписание результата проведения операции| Опис результату проведення операції |
failureCause | String |
Описание причины возникновения ошибки| Опис причини виникнення помилки |
| failureCause | Array |
Описания причин возникновения ошибки (ошибок) | Пример кода на JavaScript + jQuery 2.2.4
...
...
| Опис причини виникнення помилки (помилок) |
