Versions Compared

Key

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

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

Note
titleУвага

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

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

https://ccs-dev-api.cipher.kiev.ua/ccs/

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

URL-адрес запроса

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

Метод

PUT

...

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

Тип ключа

Допустимые значенияДопустимі значення:
signature - электронная подписьелектронний підпис
keyAgreement - согласование секретного ключа для зашифрования данных

...

шифрування

Налаштовувані заголовки запиту
Content-Typeapplication/json

...

Параметри JSON

...

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

keyStorePassword

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

publicKeyCertificateInfo
certificateSerialNumber
notBefore
notAfter
extensionsCertificateInfo

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

{
       "message" : "ОшибкаПомилка при получениеотриманні информацииінформації опро сертификатесертифікат.",
"failureCause" : ""
}

...

Параметри JSON

...

обʼєкта відповіді
ПараметрТип данныхданихОписаниеОпис
messageStringОписание результата проведения операцииОпис результату проведення операції
failureCause StringОписание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭПОпис причини появи помилки, яка виникнення при відправці запиту на перевірку ЕП
ownerCertificateInfoПолучение данных сертификатаObject*Інформація про власника
issuerCertificateInfoИнформация о владельцеПолучение данных сертификатаObject*Інформація про видавця
publicKeyCertificateInfoИнформация об издателеПолучение данных сертификатаObject*Информация об открытом ключеІнформація про відкритий ключ
certificateSerialNumberObject*Серийный Серійний номер сертификатасертифікату
notBeforeObject*Начало действияПочаток дії
notAfterObject*Окончание действияЗавершення строку дії
extensionsCertificateInfoПолучение данных сертификата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
extensionsCertificateInfo.value

ПолеТип данныхданхОписаниеОпис
Получение данных сертификатаpersonalDataObject*Персональные данныеПерсональні дані
alternativeOwnerNameObject*Альтернативное имя владельцаАльтернативне імʼя власника
subjectKeyIdObject*Идентификатор Ідентифікатор ключа
subjectOwnerIdObject*Идентификатор владельцаІдентифікатор власника
certificateProfileObject*Профиль сертификатаПрофіль сертифікату
keyUsageObject*Назначение сертификатаПризначення сертифікату
isTemporaryObject*Признак Ознака стартового сертификатасертифікату
isReinforcedObject*Признак усиленного сертификатаОзнака посиленого сертифікату
isQualifiedObject*Признак квалифицированного сертификатаОзнака кваліфікованого сертифікату
isPrivateKeyOnQSCDObject*Признак средства КЭПОзнака засобу КЕП
qscdTypeNameObject*Тип средства КЭПзасобу КЕП
isElectronicStampObject*Признак электронной печатиОзнака електронної печатки

Поля объектаобʼєкта 

Anchor
personalData
personalData
Получение данных сертификата extensionsCertificateInfo.value.personalData.value   

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

edrpou

Object*Код ЕДПРОУЄДРПОУ

eddrun

Object*

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

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

Anchor
CertObject
CertObject
Object* 

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

Пример данных сертификата

Значення поля

Приклад даних сертифікату

Code Block
{
Code Block
{
    "ownerCertificateInfo": {
        "description": "Власник",
        "value": {
            "ownerSurnameownerCertificateInfo": {"description": "Прізвище", "value": "Тестовый"},
            "ownerGivenname": {"description": "Імя по-батьковіВласник",
        "value": "Сертификат6 Стартовый"},{
            "ownerFullNameownerSurname": {"description": "Повне ім'яПрізвище", "value": "Тестовый Сертификат 6Тестовий"},
            "ownerCountryownerGivenname": {"description": "КраїнаІмя по-батькові", "value": "uaСертифікат 6 Стартовий"},
            "ownerRegionownerFullName": {"description": "ОбластьПовне ім'я", "value": "ХарьковскаяТестовий Сертифікат 6"},
            "ownerCityownerCountry": {"description": "МістоКраїна", "value": "Харьковua"},
            "ownerAddressownerRegion": {"description": "Поштова адресаОбласть", "value": "\Харківська"пр. Науки"},
            "ownerSerialNumberownerCity": {"description": "Серійний номер власникаМісто", "value": "46 30 07 62 53 88 0D 40Харків"},
            "ownerPositionownerAddress": {"description": "ПосадаПоштова адреса", "value": "Розробник"\"пр. Науки"},
        }
    },
    "issuerCertificateInfo"ownerSerialNumber": {
        "description"description": "Серійний номер власника", "value": "Видавник",
46 30 07 62 53 88 0D  "value": {40"},
            "issuerOrganizationownerPosition": {"description": "ОрганізаціяПосада", "value": "\Розробник"ТОВ \\\"Сайфер БІС\\\"\""},
}
        }
    },
    "issuerDepartmentissuerCertificateInfo": {
        "description": "ПідрозділВидавець",
        "value": "Центр сертифікації ключів"}, {
            "issuerFullNameissuerOrganization": {"description": "Повне ім'яОрганізація", "value": "\"ЦСК ТОВ \\\"Сайфер БІС\\\"\""},
            "issuerCountryissuerDepartment": {"description": "КраїнаПідрозділ", "value": "ua"},
Центр            "issuerRegion": {"description": "Область", "value": nullсертифікації ключів"},
            "issuerCityissuerFullName": {"description": "МістоПовне ім'я", "value": "Київ"\"ЦСК ТОВ \\\"Сайфер БІС\\\"\""},
            "issuerAddressissuerCountry": {"description": "Поштова адресаКраїна", "value": null"ua"},
            "issuerSerialNumberissuerRegion": {"description": "Серійний номер видавцяОбласть", "value": "46 30 07 62 53 88 0D 40"}
null},
            }
    "issuerCity": {"description": "Місто", "value": "Київ"},
    "publicKeyCertificateInfo": {
       "issuerAddress": {"description": "Інформація про відкритий ключ",
       Поштова адреса", "value": {null},
            "publicKeyissuerSerialNumber": {
           "description": "Серійний номер видавця", "value": "46 30 07 62 53 88 0D 40"}
      "description": "Відкритий ключ",}
    },
      "publicKeyCertificateInfo": {
        "valuedescription": "8DІнформація 39про 4C DA 49 7D 1D A7 46 92 FE 97 A4 1D 0B AD C3 B0 9F 1B 5C 07 8C 79 31 72 36 92 40 08 2E 13 00"
відкритий ключ",
        "value": {
            "publicKey": {
              }, "dsAlgorism": {"description": "АлгоритмВідкритий ЕПключ",
                "value": "ДСТУ 4145-2002, ПБ, little-endian"}
        }
    }, 
    "certificateSerialNumber": {"description": "Серійний номер сертифікату", "value": "E5 69 8B B0 4D A1 BF 2F"},
    "notBefore": {"description": "Початок дії", "value": "Sat Nov 19 00:00:00 EET 2016"},
    "notAfter8D 39 4C DA 49 7D 1D A7 46 92 FE 97 A4 1D 0B AD C3 B0 9F 1B 5C 07 8C 79 31 72 36 92 40 08 2E 13 00"
            }, "dsAlgorism": {"description": "ЗакінченняАлгоритм діїЕП", "value": "Sun Nov 19 00:00:00 EET 2017"}ДСТУ 4145-2002,
    "extensionsCertificateInfo": {ПБ, little-endian"}
        "description": "Розширення",
}
    }, 
    "valuecertificateSerialNumber": {
            "personalData": {
                "description": "Серійний номер сертифікату", "value": "E5 69 8B B0 4D A1 BF 2F"},
    "notBefore": {"description": "ПерсональніПочаток данідії",
 "value": "Sat Nov 19 00:00:00 EET 2016"},
    "notAfter": {"description": "Закінчення  дії", "value": {
"Sun Nov 19 00:00:00 EET 2017"},
       "extensionsCertificateInfo": {
        "customId": {"description": "Зовнішній ідентифікаторРозширення",
  "value": "000006"},
        "value": {
            "passportpersonalData": {"description": "Паспортні дані", "value": "КН000006"},

                "description": "Персональні дані",
        "drfou": {"description": "Реєстраційний номер облікової картки платника податків", "value": null},{
                    "edrpoucustomId": {"description": "КодЗовнішній ЕДПРОУідентифікатор", "value": null"000006"},
                    "eddrunpassport": {"description": "Унікальний номер запису в ЄДДРПаспортні дані", "value": null}
                }
  "КН000006"},
          },
            "alternativeOwnerNamedrfou": {"description": "Альтернативне ім'я власникаРеєстраційний номер облікової картки платника податків", "value": "test@cipher.com"null},
            "subjectKeyId": {
                "edrpou": {"description": "Код ЕДПРОУ"Ідентифікатор, ключа""value": null},
                    "valueeddrun": {"description"B6: 2F"Унікальний CEномер 32запису A7в 23 48 AB FB 26 F1 5A 4C 04 F9 1A 5E CF 03 D4 98 3E 86 AC 07 32 75 8D 59 37 4C A0"ЄДДР", "value": null}
                }
            },
            "subjectOwnerIdalternativeOwnerName": {"description": "ІдентифікаторАльтернативне ім'я власника", "value": "46 30 07 62 53 88 0D 40"},test@cipher.com"},
            "subjectKeyId": {
            "certificateProfile": {"description": "Профіль сертифіката", "valuedescription": "3Ідентифікатор ключа"},
            "keyUsage": {"description": "Призначеня сертифіката", "value": "ЕлектроннийB6 підпис, Невідрікаємість"},
            "isTemporary": {"description": "Стартовий", "value": "false"},
            "isReinforced": {"description": "Посилений", "value": "false"},
			"isQualified": {"description": "Кваліфікований", "value": "false"2F CE 32 A7 23 48 AB FB 26 F1 5A 4C 04 F9 1A 5E CF 03 D4 98 3E 86 AC 07 32 75 8D 59 37 4C A0"
            },
            "isPrivateKeyOnQSCDsubjectOwnerId": {"description": "ЗасібІдентифікатор КЕПвласника", "value": "false46 30 07 62 53 88 0D 40"},
            "qscdTypeNamecertificateProfile": {"description": "ТипПрофіль засобу КЕПсертифіката", "value": null"3"},
            "isElectronicStampkeyUsage" : {"description": "ЕлектроннаПризначення печаткасертифіката", "value": "false"}         Електронний підпис, Невідрікаємість"},
        }
    }
}
Пример кода на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url"isTemporary": {"description"https://localhost:9094/api/v1/ticket/{uuid}/keyStore/certificateInfo/signature",
    type: "PUT": "Стартовий", "value": "false"},
    dataType: "json",
	contentType: "application/json",
       data"isReinforced": JSON.stringify({keyStorePassword {"description": "12345678Посилений"})
    cache, "value": "false
}).done(function (jsonResponse, textStatus, xhr) {"},
			"isQualified": {"description": "Кваліфікований", "value": "false"},
    certInfo = jsonResponse;
}).fail(function (xhr) {
    try"isPrivateKeyOnQSCD": {
   "description": "Засіб КЕП", "value": "false"},
     var jsonResponse = JSON.parse(xhr.responseText);
    "qscdTypeName": {"description": "Тип засобу message = jsonResponse.message;
    КЕП", "value": null},
    failureCause = jsonResponse.failureCause; 
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при получении дынныхсертификата." : xhr.responseText; "isElectronicStamp" : {"description": "Електронна печатка", "value": "false"}         
        }
    }
})