Запит служить для отримання даних сертифікату ключа, який знаходиться в ключовому контейнері сесії. Якщо ключ вказаного типу відсутній, будет повернуто порожній JSON обʼєкт.
Увага
Метод підтримує захищені параметри.
Ознайомитись с описом та деталями використання захищених параметрів можливо за посиланням Створення та використання захищених параметрів.
Усі параметри JSON обʼєкту запиту можуть бути передані як захищені параметри. Якщо відкритий параметр та захищений параметр мають однакове ім'я, то буде використане значення захищеного параметра.
URL-адреса запиту
https://localhost:9094/api/v1/ticket/{uuid}/keyStore/certificate/info/{keyType}
Метод
PUT
Параметри запиту
uuid | String | Ідентифікатор сесії | |
keyType | String | Тип ключа Допустимі значення: |
Налаштовувані заголовки запиту
Content-Type | application/json |
Параметри JSON обʼєкта запиту
Імʼя | Тип | Опис | Допустимі значення |
---|---|---|---|
keyStorePassword | String | Пароль до ключового контейнеру сесії | Рядок, який являє собою пароль для доступу до ключового контейнеру. Ключовий контейнер сесії має бути раніше завантажений за допомогою спеціального запиту. |
Відповідь
Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
---|---|---|---|
200 | application/json | ownerCertificateInfo issuerCertificateInfo publicKeyCertificateInfo certificateSerialNumber notBefore notAfter extensionsCertificateInfo | |
503 | application/json | message | { |
500 | application/json | message failureCause | { |
Параметри JSON обʼєкта відповіді
Параметр | Тип даних | Опис |
---|---|---|
message | String | Опис результату проведення операції |
failureCause | String | Опис причини появи помилки, яка виникнення при відправці запиту на перевірку ЕП |
ownerCertificateInfo | Object* | Інформація про власника |
issuerCertificateInfo | Object* | Інформація про видавця |
publicKeyCertificateInfo | Object* | Інформація про відкритий ключ |
certificateSerialNumber | Object* | Серійний номер сертифікату |
notBefore | Object* | Початок дії |
notAfter | Object* | Завершення строку дії |
extensionsCertificateInfo | Object* | Розширення |
Поля обʼєкта ownerCertificateInfo.value
Поле | Тип даних | Опис |
---|---|---|
ownerSurname | Object* | Прізвище |
ownerGivenname | Object* | Імʼя по батькові |
ownerFullName | Object* | Повне імʼя |
ownerCountry | Object* | Країна |
ownerRegion | Object* | Область |
ownerCity | Object* | Населений пункт |
ownerAddress | Object* | Поштова адреса |
ownerSerialNumber | Object* | Серійний номер власника |
ownerPosition | Object* | Посада |
Поля обʼєкта issuerCertificateInfo.value
Поле | Тип даних | Опис |
---|---|---|
issuerOrganization | Object* | Організація |
issuerDepartment | Object* | Підрозділ |
issuerFullName | Object* | Повне імʼя |
issuerCountry | Object* | Країна |
issuerRegion | Object* | Область |
issuerCity | Object* | Населений пункт |
issuerAddress | Object* | Поштова адреса |
issuerSerialNumber | Object* | Серійний номер власника |
Поля обʼєкта publicKeyCertificateInfo.value
Поля обʼєкта extensionsCertificateInfo.value
Поле | Тип данх | Опис |
---|---|---|
personalData | Object* | Персональні дані |
alternativeOwnerName | Object* | Альтернативне імʼя власника |
subjectKeyId | Object* | Ідентифікатор ключа |
subjectOwnerId | Object* | Ідентифікатор власника |
certificateProfile | Object* | Профіль сертифікату |
keyUsage | Object* | Призначення сертифікату |
isTemporary | Object* | Ознака стартового сертифікату |
isReinforced | Object* | Ознака посиленого сертифікату |
isQualified | Object* | Ознака кваліфікованого сертифікату |
isPrivateKeyOnQSCD | Object* | Ознака засобу КЕП |
qscdTypeName | Object* | Тип засобу КЕП |
isElectronicStamp | Object* | Ознака електронної печатки |
Поля обʼєкта extensionsCertificateInfo.value.personalData.value
Поле | Тип даних | Опис |
---|---|---|
customId | Object* | Зовнішній ідентифікатор |
passport | Object* | Паспортні дані |
drfou | Object* | Реєстраційний номер облікової картки платників податків |
edrpou | Object* | Код ЄДРПОУ |
eddrun | Object* | Унікальний номер запису в ЄДДР |
Поля обʼєкта типу Object*
Поле | Тип даних | Опис |
---|---|---|
description | String | Опис поля на мові, яку обрано користувачем у Сервісі |
value | [Object, String, Boolean, Number, Array, null] | Значення поля |
Приклад даних сертифікату
{ "ownerCertificateInfo": { "description": "Власник", "value": { "ownerSurname": {"description": "Прізвище", "value": "Тестовий"}, "ownerGivenname": {"description": "Імя по-батькові", "value": "Сертифікат 6 Стартовий"}, "ownerFullName": {"description": "Повне ім'я", "value": "Тестовий Сертифікат 6"}, "ownerCountry": {"description": "Країна", "value": "ua"}, "ownerRegion": {"description": "Область", "value": "Харківська"}, "ownerCity": {"description": "Місто", "value": "Харків"}, "ownerAddress": {"description": "Поштова адреса", "value": "\"пр. Науки"}, "ownerSerialNumber": {"description": "Серійний номер власника", "value": "46 30 07 62 53 88 0D 40"}, "ownerPosition": {"description": "Посада", "value": "Розробник"} } }, "issuerCertificateInfo": { "description": "Видавець", "value": { "issuerOrganization": {"description": "Організація", "value": "\"ТОВ \\\"Сайфер БІС\\\"\""}, "issuerDepartment": {"description": "Підрозділ", "value": "Центр сертифікації ключів"}, "issuerFullName": {"description": "Повне ім'я", "value": "\"ЦСК ТОВ \\\"Сайфер БІС\\\"\""}, "issuerCountry": {"description": "Країна", "value": "ua"}, "issuerRegion": {"description": "Область", "value": null}, "issuerCity": {"description": "Місто", "value": "Київ"}, "issuerAddress": {"description": "Поштова адреса", "value": null}, "issuerSerialNumber": {"description": "Серійний номер видавця", "value": "46 30 07 62 53 88 0D 40"} } }, "publicKeyCertificateInfo": { "description": "Інформація про відкритий ключ", "value": { "publicKey": { "description": "Відкритий ключ", "value": "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" }, "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"}, "notAfter": {"description": "Закінчення дії", "value": "Sun Nov 19 00:00:00 EET 2017"}, "extensionsCertificateInfo": { "description": "Розширення", "value": { "personalData": { "description": "Персональні дані", "value": { "customId": {"description": "Зовнішній ідентифікатор", "value": "000006"}, "passport": {"description": "Паспортні дані", "value": "КН000006"}, "drfou": {"description": "Реєстраційний номер облікової картки платника податків", "value": null}, "edrpou": {"description": "Код ЕДПРОУ", "value": null}, "eddrun": {"description": "Унікальний номер запису в ЄДДР", "value": null} } }, "alternativeOwnerName": {"description": "Альтернативне ім'я власника", "value": "test@cipher.com"}, "subjectKeyId": { "description": "Ідентифікатор ключа", "value": "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" }, "subjectOwnerId": {"description": "Ідентифікатор власника", "value": "46 30 07 62 53 88 0D 40"}, "certificateProfile": {"description": "Профіль сертифіката", "value": "3"}, "keyUsage": {"description": "Призначення сертифіката", "value": "Електронний підпис, Невідрікаємість"}, "isTemporary": {"description": "Стартовий", "value": "false"}, "isReinforced": {"description": "Посилений", "value": "false"}, "isQualified": {"description": "Кваліфікований", "value": "false"}, "isPrivateKeyOnQSCD": {"description": "Засіб КЕП", "value": "false"}, "qscdTypeName": {"description": "Тип засобу КЕП", "value": null}, "isElectronicStamp" : {"description": "Електронна печатка", "value": "false"} } } }
Приклад коду на JavaScript + jQuery 2.2.4
$.ajax({ url: "https://localhost:9094/api/v1/ticket/{uuid}/keyStore/certificateInfo/signature", type: "PUT", dataType: "json", contentType: "application/json", data: JSON.stringify({keyStorePassword : "12345678"}) cache: false }).done(function (jsonResponse, textStatus, xhr) { certInfo = 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; } })