Versions Compared

Key

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

Запит служить для отримання результату перевірки ЕП. Запит є блокуючим, то результат буде отримано лише після завершення процесу перевірки ЕП, якщо такий був раніше запущено. Якщо ЕП дійсна, то буде повернуто HTTP статус код 200. Якщо ЕП не дійсний чи у процесі її безпосередньої перевірки виникають помилки, буде повернуто HTTP статус код 406. При появі інших типів помилок, повертаються HTTP статус коди 503 чи 400.

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

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

Запрос служит для получения результата проверки ЭП. Запрос является блокирующим, то есть результат будет получен только после завершения процесса проверки ЭП, если такой был ранее запущен. Если ЭП действительна, будет возвращен HTTP статус код 200. Если в ЭП недействительна или в процессе ее непосредственной проверки возникли ошибки, будет возвращен HTTP статус код 406. При возникновении других типов ошибок, возвращаются HTTP статус коды 503 или 400.

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

https://localhost:9094/api/v1/ticket/{uuid}/ds/verifier

Метод

GET

...

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

...

Налаштовувані заголовки

...

запиту

ОтсутствуетВідсутні

...

Відповідь
Код ответавідповідіContent-typeДопустимые параметрыДопустимі параметриПриклад вмістуПример содержимого
200application/jsonmessage
verifyResults 
{
"message" : "ЭлектроннаяЕлектронний подписьпідпис действительнадійсний.",
"verifyResults" : Array
}
503application/jsonmessage
{
       "message" : "СервисСервіс выполнениявиконання криптографическихкриптографічних операцийоперацій не запущензапущено."
}
400application/jsonmessage
{
       "message" : "СессияСесія отсутствуетвідсутня."
}
406application/jsonmessage
verifyResults
failureCause
{
       "message" : "ЭлектроннаяЕлектронний подписьпідпис не действительнадійсний.",
"failureCause" : "",
"verifyResults" : Array
}

...

Параметри JSON

...

обʼєкта відповіді
ПараметрТип данныхданихОписаниеОпис
messageStringОписание результата проведения операцииОпис результату проведення операції
failureCause StringОписание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭПОпис причини виникнення помилки, яка виникла при виконанні запиту на перевірку ЕП
verifyResultsArrayРезультаты проверки отдельно по каждой из ЭПРезультати перевірки окремо по кожній з ЕП

Поля елемента масиву Поля элемента массива verifyResults

проверка ЭП произведена без ошибок процессе проверки ЭП возникли ошибкиОписание причины возникновения ошибки, которая возникла при непосредственной проверке ЭПИнформация из сертификата владельца ЭПВремя создания ЭП ЭП действительна ЭП недействительна проверки электронной метки (ЭМВ) времени данных, для которых была создана ЭПРезультаты проверки электронных меток времени электронной подписи проверки подписи использовалось время создания подписи, которое не заверено электронной меткой времени ЭП действительна ЭП недействительна
ПолеТип данныхданихОписаниеОпис
statusString"SUCCESS" - перевірка ЕП здійснена без помилок
"FAILURE" - в
процесі перевірки ЕП виникли помилки
failureCauseStringОпис причини виникнення помилки, яка виникла при безпосередній перевірці ЕП
signerInfoObjectІнформація з сертифіката власника ЕП
signingDateTimeStringЧас створення ЕП
isValidBooleantrue - ЕП дійсний
false -
ЕП не дійсний
contentTimestampObjectРезультат перевірки електронної позначки часу (ЕПЧ) даних для яких було створено ЕП
signatureTimestampsArrayРезультати перевірки ЕПЧ електронного підпису
isUntrustedValidBooleanДля перевірки ЕП використовується час створення ЕП, яке не завірено ЕПЧ.
true -
ЕП дійсна
false -

Поля объекта contentTimestamp, элемента массива signatureTimestamps

...

ЕП не дійсний
signatureTypeString

Тип електронного підпису.
Можливі значення:

  • DETACHED
  • ATTACHED
  • ASIC_S
  • ASIC_E
signatureFormatString

Формат електронного підпису.
Можливі значення:

  • CADES_BES
  • CADES_C
  • CADES_T
  • CADES_X_LONG
  • XADES_B_B
  • XADES_B_T
  • XADES_B_LT
  • XADES_B_LTA

Поля обʼєкта contentTimestamp, елемента масиву signatureTimestamps

ПолеТип данихОпис
isValidBooleantrue - ЕПЧ дійсна
false - ЕПЧ не дійсна
isFailureBooleantrue - при перевірці ЕПЧ виникла помилка
false - при перевірці ЕПЧ помилок не виникло
dateTimeDateTimeЗначення дати та часу у форматі ISO 8601, яке завірено ЕПЧ
tsaCertificateSerialNumberObject*Серійний номер сертифікату TSP-серверу

Поля обʼєкта

Anchor
signerInfo
signerInfo
signerInfo

ПолеТип данихОпис
ownerCertificateInfoObject*Інформація про власника
issuerCertificateInfoObject*Інформація про видавця
publicKeyCertificateInfoObject*Інформація про відкритий ключ
certificateSerialNumberObject*Серійний номер сертифікату
notBeforeObject*Початок дії
notAfterObject*Кінець дії
extensionsCertificateInfoObject*Розширення

Поля обʼєкта

Anchor
ownerCertificateInfo
ownerCertificateInfo
signerInfoПоля объекта AnchorownerCertificateInfoownerCertificateInfoПолучение результата проверки ЭП.ownerCertificateInfo.value

ПолеТип данныхданихОписаниеОпис
ownerSurnameObject*ФамилияПрізвище
ownerGivennameObject*Имя отчествоІмʼя по батькові
ownerFullNameObject*Полное имяПовне імʼя
ownerCountryObject*СтранаКраїна
ownerRegionObject*Область
ownerCityObject*ГородНаселений пункт
ownerAddressObject*Почтовый адресПоштова адреса
ownerSerialNumberObject*Серийный Серійний номер владельцавласника
ownerPositionObject*ДолжностьПосада

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

Anchor
issuerCertificateInfo
issuerCertificateInfo
 Получение результата проверки ЭПsignerInfo.issuerCertificateInfo.value

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

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

Anchor
publicKeyCertificateInfo
publicKeyCertificateInfo
 Получение результата проверки ЭПsignerInfo.publicKeyCertificateInfo.value

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

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

Anchor
extensionsCertificateInfo
extensionsCertificateInfo
 Получение результата проверки ЭПsignerInfo.extensionsCertificateInfo.value

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

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

Anchor
personalData
personalData
 Получение результата проверки ЭП.Получение результата проверки ЭПsignerInfo.extensionsCertificateInfo.value.personalData.value   

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

edrpou

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

eddrun

Object*

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

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

Anchor
CertObject
CertObject
Object* 

ПолеТип данныхданихОписаниеОпис
descriptionStringОписание Опис поля на языке, который выбран пользователем в Сервисемові, який обрано користувачем у Сервісі
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": "Власник",
                    "verifyResultsvalue": [{
            {
            "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": "Тип засобу КЕП",
      }
            }
        }
    ]
}
Пример кода на JavaScript + jQuery 2.2.4
Code Block
languagejs
$.ajax({
    url: "https://localhost:9094/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 {
"value": 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; }
    }]
})