Запрос позволяет инициировать процесс использования личных ключей пользователя при выполнении Сервисом соответствующих операций. Функциональность аналогична предоставляемой пользовательским интерфейсом Сервиса, отличие лишь в способе предоставления данных. В случае использования интерфейса пользователя, путь к ключевому контейнеру, пароль к ключевому контейнеру, использоемый ЦСК и, при необходимости, сертификат ключа вводятся в соответствующие элементы управления, а при использовании REST API указанные выше данные передаются в виде JSON объекта.
В случае успешного выполнения запроса сервис начинает использовать личные ключи, интерфейс пользователя начинает отображать информацию из сертификата ключа и доступные пользователю действия.
Запрос не будет выполнен, если Сервис уже использует личные ключи. Для завершения использования личных ключей посредством REST API необходимо использовать запрос Завершение использования личных ключей.
URL-адрес запроса
https://local.cipher.kiev.ua:9091/api/v1/personalKeysSession
Метод
POST
Параметры запроса
Отсутствуют
Настраиваемые заголовки запроса
Content-Type | application/json |
Параметры JSON объекта запроса
Имя | Тип | Описание | Допустимые значения |
---|---|---|---|
keyStorage | String | Путь к ключевому контейнеру или к защищенному носителю | Для файлового контейнера поле должно содержать действительный путь к файлу с ключевым контейнером. Для защищенного носителя поле должно содержать специальный идентификатор подключенного к хосту защищенного носителя. Для получения списка специальных идентификаторов, которые соответствуют подключенным к хосту защищенным носителям, необходимо использовать запрос Получение списка подключенных защищенных носителей. |
keyStoragePassword | String | Пароль к ключевому контейнеру | |
cartificatePath | String | Путь к файлу с сертификатом ключа, который находится в ключевом контейнере | |
caId | String | Идентификатор (А)ЦСК, который издал сертификат ключа из ключевого контейнера. | Идентификаторы поддерживаемых Сервисом (А)ЦСК необходимо предварительно получить с помощью запроса Получение списка поддерживаемых (А)ЦСК |
Ответ
Код ответа | Content-type | Допустимые параметры | Пример содержимого |
---|---|---|---|
200 | application/json | message | { |
503 | application/json | message | { |
400 | application/json | message | { "message" : "Запрос не содержит JSON объекта с дополнительными данными." } |
500 | application/json | message failureCause | { { |
Параметры JSON объекта ответа
Параметр | Тип данных | Описание |
---|---|---|
message | String | Описание результата проведения операции |
failureCause | String | Описание причины возникновения ошибки |
failureCause | Array | Описания причин возникновения ошибки (ошибок) |
Пример кода на JavaScript + jQuery 2.2.4
var credential= { "keyStorage" : "Z:\\cert\\c33.pfx", "keyStoragePassword" : "123456718", "certificatePath" : "", "caId" : "testIitCipher" } $.ajax({ url: "https://local.cipher.kiev.ua:9091/api/v1/personalKeysSession", type: "POST", dataType: "json", contentType: "application/json", data: JSON.stringify(credential) }).done(function (jsonResponse, textStatus, xhr) { message = jsonResponse.message; settedOptions = jsonResponse.settedOptions; }).fail(function (xhr) { try { var jsonResponse = JSON.parse(xhr.responseText); message = jsonResponse.message; } catch (e) { message = (xhr.responseText == undefined) ? "Ошибка при выполнении запроса на использование личных ключей." : xhr.responseText; } })