Запит служить для отримання результату перевірки ЕП. Запит є блокуючим, то результат буде отримано лише після завершення процесу перевірки ЕП, якщо такий був раніше запущено. Якщо ЕП дійсна, то буде повернуто HTTP статус код 200. Якщо ЕП не дійсний чи у процесі її безпосередньої перевірки виникають помилки, буде повернуто HTTP статус код 406. При появі інших типів помилок, повертаються HTTP статус коди 503 чи 400.
URL-адреса запиту
Запрос служит для получения результата проверки ЭП. Запрос является блокирующим, то есть результат будет получен только после завершения процесса проверки ЭП, если такой был ранее запущен. Если ЭП действительна, будет возвращен HTTP статус код 200. Если в ЭП недействительна или в процессе ее непосредственной проверки возникли ошибки, будет возвращен HTTP статус код 406. При возникновении других типов ошибок, возвращаются HTTP статус коды 503 или 400.
...
https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/ds/verifier
Метод
GET
...
Параметри запиту
uuid | StringИдентификатор | сессииІдентифікатор сесії |
...
Налаштовувані заголовки
...
запиту
ОтсутствуетВідсутні
...
Відповідь
Код ответавідповіді | Content-type | Допустимые параметры | Допустимі параметри | Приклад вмістуПример содержимого |
---|---|---|---|---|
200 | application/json | message verifyResults | { | |
503 | application/json | message | { | |
400 | application/json | message | { | |
406 | application/json | message verifyResults failureCause | { |
...
Параметри JSON
...
обʼєкта відповіді
Параметр | Тип данныхданих | ОписаниеОпис | |
---|---|---|---|
message | String | Описание результата проведения операцииОпис результату проведення операції | |
failureCause | String | Описание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭПОпис причини виникнення помилки, яка виникла при виконанні запиту на перевірку ЕП | |
verifyResults | Array | Результаты проверки отдельно по каждой из ЭП | Результати перевірки окремо по кожній з ЕП |
Поля елемента масиву Поля элемента массива verifyResults
Поле | Тип данныхданих | ОписаниеОпис | ||
---|---|---|---|---|
status | String | "SUCCESS" - | проверка ЭП произведена без ошибокперевірка ЕП здійснена без помилок "FAILURE" - в | процессе проверки ЭП возникли ошибкипроцесі перевірки ЕП виникли помилки |
failureCause | String | Описание причины возникновения ошибки, которая возникла при непосредственной проверке ЭПОпис причини виникнення помилки, яка виникла при безпосередній перевірці ЕП | ||
signerInfo | Object | Информация из сертификата владельца ЭПІнформація з сертифіката власника ЕП | ||
signingDateTime | String | Время выработки ЭПЧас створення ЕП | ||
isValid | Boolean | true - | ЭП действительнаЕП дійсний false - | ЭП недействительнаЕП не дійсний |
contentTimestamp | Object | Результат | проверки электронной метки (ЭМВ) времени данных, для которых была выработана ЭПперевірки електронної позначки часу (ЕПЧ) даних для яких було створено ЕП | |
signatureTimestamps | Array | Результаты проверки электронных меток времени электронной подписиРезультати перевірки ЕПЧ електронного підпису | ||
isUntrustedValid | Boolean | Для | проверки подписи использовалось время создания подписи, которое не заверено электронной меткой времениперевірки ЕП використовується час створення ЕП, яке не завірено ЕПЧ. true - | ЭП действительнаЕП дійсна false - | ЭП недействительна
Поля объекта contentTimestamp, элемента массива signatureTimestamps
...
ЕП не дійсний | ||
signatureType | String | Тип електронного підпису.
|
signatureFormat | String | Формат електронного підпису.
|
Поля обʼєкта contentTimestamp, елемента масиву signatureTimestamps
Поле | Тип даних | Опис |
---|---|---|
isValid | Boolean | true - ЕПЧ дійсна false - ЕПЧ не дійсна |
isFailure | Boolean | true - при перевірці ЕПЧ виникла помилка false - при перевірці ЕПЧ помилок не виникло |
dateTime | DateTime | Значення дати та часу у форматі ISO 8601, яке завірено ЕПЧ |
tsaCertificateSerialNumber | Object* | Серійний номер сертифікату TSP-серверу |
Поля обʼєкта
Anchor | ||||
---|---|---|---|---|
|
Поле | Тип даних | Опис |
---|---|---|
ownerCertificateInfo | Object* | Інформація про власника |
issuerCertificateInfo | Object* | Інформація про видавця |
publicKeyCertificateInfo | Object* | Інформація про відкритий ключ |
certificateSerialNumber | Object* | Серійний номер сертифікату |
notBefore | Object* | Початок дії |
notAfter | Object* | Кінець дії |
extensionsCertificateInfo | Object* | Розширення |
Поля обʼєкта
Anchor | ||||
---|---|---|---|---|
|
Поле | Тип даних | Опис |
---|---|---|
ownerSurname | Object* | Прізвище |
ownerGivenname | Object* | Імʼя по батькові |
ownerFullName | Object* | Повне імʼя |
ownerCountry | Object* | Країна |
ownerRegion | Object* | Область |
ownerCity | Object* | Населений пункт |
ownerAddress | Object* | Поштова адреса |
ownerSerialNumber | Object* | Серійний номер власника |
ownerPosition | Object* | Посада |
Поля обʼєкта
signerInfo.issuerCertificateInfo.value Anchor issuerCertificateInfo issuerCertificateInfo
Поле | Тип даних | Опис |
---|---|---|
issuerOrganization | Object* | Організація |
issuerDepartment | Object* | Підрозділ |
issuerFullName | Object* | Повне імʼя |
issuerCountry | Object* | Країна |
issuerRegion | Object* | Область |
issuerCity | Object* | Населений пункт |
issuerAddress | Object* | Поштова адреса |
issuerSerialNumber | Object* | Серійний номер власника |
Поля обʼєкта
signerInfo.publicKeyCertificateInfo.value Anchor publicKeyCertificateInfo publicKeyCertificateInfo
Поля обʼєкта
signerInfo.extensionsCertificateInfo.value Anchor extensionsCertificateInfo extensionsCertificateInfo
Поле | Тип даних | Опис |
---|---|---|
personalData | Object* | Персональні дані |
alternativeOwnerName | Object* | Альтернативне імʼя власника |
subjectKeyId | Object* | Ідентифікатор ключа |
issuerKeyId | Object* | Ідентифікатор ключа видавця |
subjectOwnerId | Object* | Ідентифікатор власника |
certificateProfile | Object* | Профіль сертифікату |
keyUsage | Object* | Призначення сертифікату |
isTemporary | Object* | Ознака стартового сертифікату |
isReinforced | Object* | Ознака посиленого сертифікату |
isQualified | Object* | Ознака кваліфікованого сертифікату |
isPrivateKeyOnQSCD | Object* | Ознака засобу КЕП |
qscdTypeName | Object* | Тип засобу КЕП |
isElectronicStamp | Object* | Ознака електронної печатки |
Поля обʼєкта
signerInfo.extensionsCertificateInfo.value.personalData.value Anchor personalData personalData
Поле | Тип даних | Опис |
---|---|---|
customId | Object* | Зовнішній ідентифікатор |
passport | Object* | Паспортні дані |
drfou | Object* | Реєстраційний номер облікової картки платника податків |
edrpou | Object* | Код ЄДРПОУ |
eddrun | Object* | Унікальний номер запису в ЄДДР |
Поля обʼєкта типу
Anchor | ||||
---|---|---|---|---|
|
Поле | Тип даних | Опис |
---|---|---|
description | String | Опис поля на мові, який було вибрано у Сервісі |
value | [Object, String, Boolean, Number, Array, null] | Значення поля |
Приклад обʼєкта signerInfo
Code Block |
---|
{
"message": "Електронний підпис дійсний.",
"verifyResults": [
{
"status": "SUCCESS",
"failureCause": "",
"isValid": true,
"signingDateTime": "2020-03-05T13:25:36Z",
"contentTimestamp": {},
"signatureTimestamps": [
{
"isValid": true,
"isFailure": false,
"dateTime": "2020-03-05T13:25:39Z",
"tsaCertificateSerialNumber": "3DB73E7BF0D575B20200000001000000BB000000"
}
],
"signerInfo": {
"ownerCertificateInfo": {
"description": "Власник",
"value": {
|
...
Поле | Тип данных | Описание |
---|---|---|
customId | Object* | Внешний идентификатор |
passport | Object* | Паспортные данные |
drfou | Object* | Регистрационный номер учетной карточки плательщика налогов |
edrpou | Object* | Код ЕДПРОУ |
eddrun | Object* | Уникальный номер записи в ЕГДР |
...
Пример объекта signerInfo
Code Block |
---|
{ "message": "Електронний підпис дійсний.", "verifyResults": [ { "statusownerSurname": "SUCCESS",{ "failureCause": "", "isValiddescription": true"Прізвище", "signingDateTime": "2020-03-05T13:25:36Z", "contentTimestampvalue": {},"Боровіков" "signatureTimestamps": [ }, { "isValidownerGivenname": true, { "isFailuredescription": false "Імя по-батькові", "dateTime "value": "2020-03-05T13:25:39Z",Олександр Михайлович" "tsaCertificateSerialNumber": "3DB73E7BF0D575B20200000001000000BB000000" }, } ],"ownerFullName": { "signerInfo": { "ownerCertificateInfodescription": { "Повне ім'я", "description": "Власник", "value": "Боровіков Олександр Михайлович" "value": { }, "ownerSurnameownerCountry": { "description": "ПрізвищеКраїна", "value": "БоровіковUA" }, "ownerGivennameownerRegion": { "description": "Імя по-батьковіОбласть", "value": "Олександр Михайлович"null }, "ownerFullNameownerCity": { "description": "Повне ім'яМісто", "value": "Боровіков Олександр МихайловичКиїв" }, "ownerCountryownerAddress": { "description": "КраїнаПоштова адреса", "value": "UA"null }, "ownerRegionownerSerialNumber": { "description": "ОбластьСерійний номер власника", "value": null"2423814" }, "ownerCityownerPosition": { "description": "МістоПосада", "value": "Київ"null }, "ownerAddressownerOrganization": { "description": "Поштова адресаОрганізація", "value": null }, "ownerSerialNumberownerOrganizationUnit": { "description": "Серійний номер власникаВідділ (підрозділ)", "value": "2423814"null }, } "ownerPosition": { }, "descriptionissuerCertificateInfo": "Посада", { "valuedescription": null"Видавник", },"value": { "ownerOrganizationissuerOrganization": { "description": "Організація", "value": null "Інформаційно-довідковий департамент ДФС" }, "ownerOrganizationUnitissuerDepartment": { "description": "Відділ (підрозділ)Підрозділ", "value": null "Управління (центр) сертифікації ключів ІДД ДФС" }, } "issuerFullName": { }, "issuerCertificateInfodescription": { "Повне ім'я", "description "value": "Видавник", Акредитований центр сертифікації ключів ІДД ДФС" "value": { }, "issuerOrganizationissuerCountry": { "description": "ОрганізаціяКраїна", "value": "Інформаційно-довідковий департамент ДФСUA" }, "issuerDepartmentissuerRegion": { "description": "ПідрозділОбласть", "value": "Управління (центр) сертифікації ключів ІДД ДФС"value": null }, "issuerFullNameissuerCity": { "description": "Повне ім'яМісто", "value": "Акредитований центр сертифікації ключів ІДД ДФСКиїв" }, "issuerCountryissuerAddress": { "description": "КраїнаПоштова адреса", "value": "UA"null }, "issuerRegionissuerSerialNumber": { "description": "ОбластьСерійний номер видавця", "value": null"UA-39384476-2018" }, } "issuerCity": { }, "publicKeyCertificateInfo": { "description": "МістоІнформація про відкритий ключ", "value": "Київ"{ }, "publicKey": { "issuerAddressdescription": { "Відкритий ключ", "descriptionvalue": "Поштова адреса", "value": nullC4 39 B0 5D 95 8A 6D 95 0E 4D F4 71 2A 62 59 6B A1 55 C9 6A 91 99 21 01 8E D3 7B B4 72 11 E6 F9 00" }, "issuerSerialNumberdsAlgorism": { "description": "СерійнийАлгоритм номер видавцяЕП", "value": "UA-39384476-2018ДСТУ 4145-2002, ПБ, little-endian" } } }, "publicKeyCertificateInfo": { "description": "Інформація про відкритий ключ", "valuecertificateSerialNumber": { "publicKeydescription": { "Серійний номер сертифікату", "descriptionvalue": "Відкритий ключ20B4E4ED0D30998C0400000006FC24004DAD7500", }, "value": "C4 39 B0 5D 95 8A 6D 95 0E 4D F4 71 2A 62 59 6B A1 55 C9 6A 91 99 21 01 8E D3 7B B4 72 11 E6 F9 00""notBefore": { "description": "Початок дії", },"value": "2019-06-10T21:00:00Z" }, "dsAlgorism": { "notAfter": { "description": "АлгоритмЗакінчення ЕПдії", "value": "ДСТУ 4145-2002, ПБ, little-endian2021-06-10T21:00:00Z" }, } "extensionsCertificateInfo": { } "description": "Розширення", }, "certificateSerialNumbervalue": { "descriptionpersonalData": "Серійний номер сертифікату", { "valuedescription": "20B4E4ED0D30998C0400000006FC24004DAD7500Персональні дані", }, "notBeforevalue": { "description "customId": "Початок дії", { "value": "2019-06-10T21:00:00Z" "description": "Зовнішній }ідентифікатор", "notAfter": { "descriptionvalue": "Закінчення дії",null "value": "2021-06-10T21:00:00Z" }, "extensionsCertificateInfo": { "descriptionpassport": "Розширення",{ "value": { "description": "Паспортні дані", "personalData": { "descriptionvalue": null "Персональні дані", "value": { }, "customIddrfou": { "description": "Зовнішній ідентифікаторРеєстраційний номер облікової картки платника податків", "value": null"2031914098" }, "passportedrpou": { "description": "ПаспортніКод даніЕДПРОУ", "value": null }, "drfoueddrun": { "description": "РеєстраційнийУнікальний номер обліковоїзапису картки платника податків", "value": "2031914098" в ЄДДР", },"value": null "edrpou": { } } "description": "Код ЕДПРОУ", }, "valuealternativeOwnerName": null{ "description": "Альтернативне }ім'я власника", "eddrunvalue": {null }, "description": "Унікальний номер запису в ЄДДР", "subjectKeyId": { "value": nulldescription": "Ідентифікатор ключа", "value": "9E 03 BA } B2 24 4C 3D 02 09 41 08 8E 7E A3 E8 81 CD C6 90 58 B5 9B 38 1F 90 98 DC 5D F3 EF 61 }8E" }, "alternativeOwnerNameissuerKeyId": { "description": "АльтернативнеІдентифікатор ім'яключа власникавидавця", "value": null }, "subjectKeyId": { "20 B4 E4 ED 0D 30 99 8C BE 30 6A 07 7D 69 9A 32 73 23 8A E9 09 08 71 D6 16 37 0E 18 E5 76 D4 7F" "description": "Ідентифікатор ключа"}, "valuesubjectOwnerId": "9E{ 03 BA B2 24 4C 3D 02 09 41 08 8E 7E A3 E8 81 CD C6 90 58 B5 9B 38 1F 90 98 DC 5D F3 EF 61 8E""description": "Ідентифікатор власника", }, "value": "00" "issuerKeyId": { }, "descriptioncertificateProfile": "Ідентифікатор ключа видавця",{ "valuedescription": "20 B4 E4 ED 0D 30 99 8C BE 30 6A 07 7D 69 9A 32 73 23 8A E9 09 08 71 D6 16 37 0E 18 E5 76 D4 7F"Профіль сертифіката", "value": null }, "subjectOwnerIdkeyUsage": { "description": "ІдентифікаторПризначення власникасертифіката", "value": "00Електронний підпис, Невідрікаємість" }, "certificateProfileisTemporary": { "description": "Профіль сертифікатаСтартовий", "value": null"false" }, "keyUsageisReinforced": { "description": "Призначеня сертифікатаПосилений", "value": "Електронний підпис, Невідрікаємістьtrue" }, "isTemporaryisQualified": { "description": "СтартовийКваліфікований", "value": "falsetrue" }, "isReinforcedisPrivateKeyOnQSCD": { "description": "ПосиленийЗасіб КЕП", "value": "truefalse" }, } "qscdTypeName": { "description": "Тип засобу } КЕП", } } "value": ] } |
Пример кода на JavaScript + jQuery 2.2.4
Code Block | ||
---|---|---|
| ||
$.ajax({ url: "https://local.cipher.kiev.ua:9090/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/ds/verifier", type: "GET", dataType: "json", cache: false }).done(function (jsonResponse, textStatus, xhr) { message = jsonResponse.message; verifyResults = jsonResponse.verifyResults; }).fail(function (xhr) { try { null }, "isElectronicStamp" : { "description": "Електронна печатка", "value": "false" var jsonResponse = JSON.parse(xhr.responseText); } message = jsonResponse.message; failureCause = jsonResponse.failureCause; } verifyResults = jsonResponse.verifyResults; } catch (e) {} message = (xhr.responseText == undefined)} ? "Ошибка при получении результата проверки ЭП." : xhr.responseText;} }] }) |