Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Настраиваемые заголовки запроса
Content-Typeapplication/json
Параметры JSON объекта запроса
Имя
Тип
Описание
Допустимые значения

keyStorePassword

StringПароль к ключевому контейнеру сесииСтрока, которая представляет собой пароль для доступа к ключевому контейнеру сессии. Ключевой контейнер сессии должен быть ранее загружен с помощью специального запроса.
Ответ
Код ответаContent-typeДопустимые параметрыПример содержимого
200application/jsonkeyAgreement
signature
 

503application/jsonmessage
{
    "message" : "Сервис хранения данных не запущен."
}
500application/jsonmessage


{
    "message" : "Помилка завантаження ключового контейнера: Невірний пароль до ключового контейнера або порушено його цілісність."
}
Параметры JSON объекта ответа
ПараметрТип данныхОписание
messageStringОписание результата проведения операции
 signatureПолучение данных о ключевом контейнереИнформация о возможности использовании ключа ЭП
 keyAgreementПолучение данных о ключевом контейнереИнформация о возможности использовании ключа согласования ключей

Поля объекта

Anchor
KeyUsageInfo
KeyUsageInfo
KeyUsageInfo

ПолеТип данныхОписание
canBeUsedBooleanКлюч присутствует в ключевом контейнере и нет ограничений на его использование
messageStringЕсли canBeUsed=false, то message содержит описание причины, по которой ключ не может быть использован.
Если canBeUsed=false, а message не содержит значения, то указанній ключ ключа отсутствует в ключевом контейнере.
Если canBeUsed=true, то message может содержать предупреждение, например, о том, что до окончания срока действия ключей осталось менее 14 дней, или о наличии в контейнере ранее сформированного запроса на смену ключей и т.п.
certificateInfoПолучение данных о ключевом контейнереДанные из сертификата ключа

Поля объекта

Anchor
CertificateInfo
CertificateInfo
CertificateInfo

ПолеТип данныхОписание
Получение данных о ключевом контейнереObject*Информация о владельце
Получение данных о ключевом контейнереObject*Информация об издателе
Получение данных о ключевом контейнереObject*Информация об открытом ключе
certificateSerialNumberObject*Серийный номер сертификата
notBeforeObject*Начало действия
notAfterObject*Окончание действия
Получение данных о ключевом контейнереObject*Расширения
  
 



Поля объекта

Anchor
ownerCertificateInfo
ownerCertificateInfo
 ownerCertificateInfo.value

ПолеТип данныхОписание
ownerSurnameObject*Фамилия
ownerGivennameObject*Имя отчество
ownerFullNameObject*Полное имя
ownerCountryObject*Страна
ownerRegionObject*Область
ownerCityObject*Город
ownerAddressObject*Почтовый адрес
ownerSerialNumberObject*Серийный номер владельца
ownerPositionObject*Должность

Поля объекта 

Anchor
issuerCertificateInfo
issuerCertificateInfo
 issuerCertificateInfo.value

ПолеТип данныхОписание
issuerOrganizationObject*Организация
issuerDepartmentObject*Подразделение
issuerFullNameObject*Полное имя
issuerCountryObject*Страна
issuerRegionObject*Область
issuerCityObject*Город
issuerAddressObject*Почтовый адрес
issuerSerialNumberObject*Серийный номер издателя

Поля объекта 

Anchor
publicKeyCertificateInfo
publicKeyCertificateInfo
 publicKeyCertificateInfo.value

ПолеТип данныхОписание
publicKeyObject*Открытый ключ
dsAlgorismObject*Алгоритм ЭП

Поля объекта 

Anchor
extensionsCertificateInfo
extensionsCertificateInfo
 signerInfo.extensionsCertificateInfo.value

ПолеТип данныхОписание
Получение данных о ключевом контейнереObject*Персональные данные
alternativeOwnerNameObject*Альтернативное имя владельца
subjectKeyIdObject*Идентификатор ключа
subjectOwnerIdObject*Идентификатор владельца
certificateProfileObject*Профиль сертификата
keyUsageObject*Назначение сертификата
isTemporaryObject*Признак стартового сертификата
isReinforcedObject*Признак усиленного сертификата

Поля объекта 

Anchor
personalData
personalData
 Получение данных о ключевом контейнере.value.personalData.value   

ПолеТип данныхОписание
customIdObject*Внешний идентификатор
passportObject*Паспортные данные
drfouObject*Регистрационный номер учетной карточки плательщика налогов

edrpou

Object*Код ЕДПРОУ

eddrun

Object*

Уникальный номер записи в ЕГДР

Поля объекта типа 

Anchor
CertObject
CertObject
Object* 

ПолеТип данныхОписание
descriptionStringОписание поля на языке, который выбран пользователем в Сервисе
value[Object, String, Boolean, Number, Array, null]Значение поля

Пример объекта JSON объекта ответа

...

Code Block
languagejs
$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/keyStore/verifier",
    type: "PUT",
    dataType: "json",
	contentType: "application/json",
    data: JSON.stringify({keyStorePassword : "12345678"})
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    containerInfo = jsonResponse;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause; 
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при проверке ключевого контейнера." : xhr.responseText;
    }
})

...