Versions Compared

Key

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

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

URL-

...

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

https://localhost:9092local.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

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

Поля объектаоб`єкту 

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"
                        },
                        "subjectOwnerIdissuerKeyId": {
                            "description": "Ідентифікатор власникаключа видавця",
                            "value": "CD20 60B4 B2E4 27ED E50D E730 0099 E1"
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"
                        "certificateProfile": },
                        "subjectOwnerId": {
                            "description": "ПрофільІдентифікатор сертифікатавласника",
                            "value": "3CD 60 B2 27 E5 E7 00 E1"
                        },
                        "keyUsagecertificateProfile": {
                            "description": "ПризначеняПрофіль сертифіката",
                            "value": "Електронний підпис3"
                        },
                        "isTemporarykeyUsage": {
                            "description": "СтартовийПризначення сертифіката",
                            "value": "falseЕлектронний підпис"
                        },
                        "isReinforcedisTemporary": {
                            "description": "ПосиленийСтартовий",
                            "value": "false"
                        },
                    }
    "isReinforced": {
           }
            }
      "description": "Посилений",
                            "value": "false"
                        },
						"isQualified": {
                            "description": "Кваліфікований",
                            "value": "false"
                        },
                        "isPrivateKeyOnQSCD": {
                            "description": "Засіб КЕП",
                            "value": "false"
                        },
                        "qscdTypeName": {
                            "description": "Тип засобу КЕП",
                            "value": null
                        },
                 ]
}
Пример кода на 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       "isElectronicStamp" : {
                            "description": "Електронна печатка",
    dataType: "json",
        cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    message = jsonResponse.message;
    modifyResults = jsonResponse.modifyResults;
}).fail(function (xhr) {
"value": "false"
            try {
        var jsonResponse = JSON.parse(xhr.responseText); }
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause; }
        modifyResults = jsonResponse.modifyResults;
    } catch (e) {}
        message = (xhr.responseText == undefined)}
 ? "Ошибка при получении результата модификации ЭП." : xhr.responseText; }
    }]
})