Versions Compared

Key

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

Запрос служит для контроля состояния процесса асинхронной модификации ЭП. Если процесс находится в стадии выполнения будет возвращен Запит служить для контролю стану процесу асинхронної модифікації ЕП. Якщо процес знаходиться на стадії виконання буде повернуто HTTP статус код 202, в случае успешного завершения - 200 с дополнительными данными об процессе модификации ЭП. В остальных случаях возвращаются соответствующие коды из серий 4хх и у випадку успішного завершення - 200  з додатковими даними про процес модифікації ЕП. В інших випадках повертаються відповідні коди з серії 4хх та 5хх.

URL-

...

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

https://localhost:9092/api/v1/ticket/{uuid}/ds/modifier

Метод

GET

...

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

...

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

...

запиту

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

...

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

...

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

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

ПолеТип данныхданихОписаниеОпис
statusString"SUCCESS" - модификация ЭП произведена без ошибокмодифікація ЕП здійснена без помилок
"FAILURE" - в процессе модификации ЭП возникли ошибкипроцесі модифікації ЕП виникли помилки
failureCauseStringОписание причины возникновения ошибки, которая возникла при непосредственной модификации ЭПОпис причини виникнення помилок, які з'явились при безпосередній модифікації ЕП
signerInfoObjectИнформация из сертификата владельца ЭПІнформація з сертифікату власника ЕП
previousSignatureFormatStringФормат исходной ЭП. Допустимые форматы исходной подписи.вихідного ЕП. Допустимі формати вихідного підпису
currentSignatureFormatStringФормат ЭП после выполнения модификации. Допустимые форматы подписи после модификации.ЕП після виконання модифікації. Допустимі формати після модифікації 
previousSignatureTypeStringТип исходной ЭП. Допустимые типы исходной подписи.вихідного ЕП. Допустимі типи вихідного підпису
currentSignatureTypeStringТип ЭП после выполнения модификации. Допустимые типы подписи после модификации.ЕП після виконання модифікації. Допустимі типи підпису після модифікації

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

Anchor
ownerCertificateInfo
ownerCertificateInfo
Получение результата модификации ЭПsignerInfo.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": "Електронний підпис успішно модифікований.",
    "modifyResults": [
        {
            "status": "SUCCESS",
            "previousSignatureFormat": "CADES_BES",
            "currentSignatureFormat": "CADES_X_LONG",
            "previousSignatureType": "DETACHED",
            "currentSignatureType": "ATTACHED",
            "signerInfo": {
                "ownerCertificateInfo": {
                    "description": "Власник",
                    "value": {
                        "ownerSurname": {
                            "description": "Прізвище",
                            "value": "Тестовий"
                        },
                        "ownerGivenname": {
                            "description": "Імя по-батькові",
                            "value": "FIleContainer"
                        },
                        "ownerFullName": {
                            "description": "Повне ім'я",
                            "value": "Тестовый 33"
                        },
                        "ownerCountry": {
                            "description": "Країна",
                            "value": "UA"
                        },
                        "ownerRegion": {
                            "description": "Область",
                            "value": "Харківська"
                        },
                        "ownerCity": {
                            "description": "Місто",
                            "value": "Харків"
                        },
                        "ownerAddress": {
                            "description": "Поштова адреса",
                            "value": null
                        },
                        "ownerSerialNumber": {
                            "description": "Серійний номер власника",
                            "value": "CD60B227E5E700E1"
                        },
                        "ownerPosition": {
                            "description": "Посада",
                            "value": "Розробник"
                        },
                        "ownerOrganization": {
                            "description": "Організація",
                            "value": "Сайфер"
                        },
                        "ownerOrganizationUnit": {
                            "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": "UA-33349855-0002"
                        }
                    }
                },
                "publicKeyCertificateInfo": {
                    "description": "Інформація про відкритий ключ",
                    "value": {
                        "publicKey": {
                            "description": "Відкритий ключ",
                            "value": "84 30 D6 9D 69 7B D7 77 3F 2E 13 44 56 7C 74 D2 6B FA D3 6E CF B8 AE D5 F6 87 44 9F A1 5F 7D BF 00"
                        },
                        "dsAlgorism": {
                            "description": "Алгоритм ЕП",
                            "value": "ДСТУ 4145-2002, ПБ, little-endian"
                        }
                    }
                },
                "certificateSerialNumber": {
                    "description": "Серійний номер сертифікату",
                    "value": "63 EF 3F 5D 24 76 4D 26"
                },
                "notBefore": {
                    "description": "Початок дії",
                    "value": "2018-09-26T06:30:35Z"
                },
                "notAfter": {
                    "description": "Закінчення дії",
                    "value": "2019-09-25T21:00:00Z"
                },
                "extensionsCertificateInfo": {
                    "description": "Розширення",
                    "value": {
                        "personalData": {
                            "description": "Персональні дані",
                            "value": {
                                "customId": {
                                    "description": "Зовнішній ідентифікатор",
                                    "value": "0033"
                                },
                                "passport": {
                                    "description": "Паспортні дані",
                                    "value": "АА000033"
                                },
                                "drfou": {
                                    "description": "Реєстраційний номер облікової картки платника податків",
                                    "value": "0000000033"
                                },
                                "edrpou": {
                                    "description": "Код ЕДПРОУ",
                                    "value": null
                                },
                                "eddrun": {
                                    "description": "Унікальний номер запису в ЄДДР",
                                    "value": "10000000000033"
                                }
                            }
                        },
                        "alternativeOwnerName": {
                            "description": "Альтернативне ім'я власника",
                            "value": "test@cipher.com.ua"
                        },
                        "subjectKeyId": {
                            "description": "Ідентифікатор ключа",
                            "value": "41 BB 81 56 29 F1 08 FD 48 F3 AF 19 D6 7B A8 4A 51 FA F4 AA 1C 20 1C 9A B4 A0 E5 73 08 20 00 9C"
                        },
                        "issuerKeyId": {
                            "description": "Ідентифікатор ключа видавця",
                            "value": "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"
                        },
                        "subjectOwnerId": {
                            "description": "Ідентифікатор власника",
                            "value": "CD 60 B2 27 E5 E7 00 E1"
                        },
                        "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
Code Block
languagejs
$.ajax({
    url: "https://localhost:9092/api/v1/ticket/79343564-147f-4a2a-ac2a-182d7a55f802/ds/modifier",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    modifyResults = jsonResponse.modifyResults;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause; 
        modifyResults = jsonResponse.modifyResults;
    } catch (e) {
        message = (xhr.responseText == undefined) ? "ОшибкаПомилка при полученииотриманні результатарезультату модификациимодифікації ЭПЕП." : xhr.responseText;
    }
})

...