Versions Compared

Old Version 7

changes.mady.by.user Svitlana Nimych

Saved on

compared with

New Version 8

changes.mady.by.user Svitlana Nimych

Saved on

Key

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

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

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

https://local.cipher.kiev.ua:9090/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

ПолеТип данихОпис
personalDataObject*Персональні дані
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://local.cipher.kiev.ua:9090/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;
    }
})