Получение результата модификации ЭП

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

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

https://local.cipher.kiev.ua:9090/api/v1/ticket/{uuid}/ds/modifier

Метод

GET

Параметры запроса

uuid

String

Идентификатор сессии

Настраиваемые заголовки запроса

Отсутствует

Ответ

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

Параметры JSON объекта ответа

Параметр	Тип данных	Описание
message	String	Описание результата проведения операции
failureCause	String	Описание причины возникновения ошибки, которая возникла при выполнении запроса на модификацию ЭП
modifyResults	Array	Результаты модификации отдельно по каждой из ЭП

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

Поле	Тип данных	Описание
status	String	"SUCCESS" - модификация ЭП произведена без ошибок "FAILURE" - в процессе модификации ЭП возникли ошибки
failureCause	String	Описание причины возникновения ошибки, которая возникла при непосредственной модификации ЭП
signerInfo	Object	Информация из сертификата владельца ЭП
previousSignatureFormat	String	Формат исходной ЭП. Допустимые форматы исходной подписи.
currentSignatureFormat	String	Формат ЭП после выполнения модификации. Допустимые форматы подписи после модификации.
previousSignatureType	String	Тип исходной ЭП. Допустимые типы исходной подписи.
currentSignatureType	String	Тип ЭП после выполнения модификации. Допустимые типы подписи после модификации.

Поля объекта Получение результата модификации ЭП.ownerCertificateInfo.value

Поле	Тип данных	Описание
ownerSurname	Object*	Фамилия
ownerGivenname	Object*	Имя отчество
ownerFullName	Object*	Полное имя
ownerCountry	Object*	Страна
ownerRegion	Object*	Область
ownerCity	Object*	Город
ownerAddress	Object*	Почтовый адрес
ownerSerialNumber	Object*	Серийный номер владельца
ownerPosition	Object*	Должность

Поля объекта Получение результата модификации ЭП.issuerCertificateInfo.value

Поле	Тип данных	Описание
issuerOrganization	Object*	Организация
issuerDepartment	Object*	Подразделение
issuerFullName	Object*	Полное имя
issuerCountry	Object*	Страна
issuerRegion	Object*	Область
issuerCity	Object*	Город
issuerAddress	Object*	Почтовый адрес
issuerSerialNumber	Object*	Серийный номер издателя

Поля объекта Получение результата модификации ЭП.publicKeyCertificateInfo.value

Поле	Тип данных	Описание
publicKey	Object*	Открытый ключ
dsAlgorism	Object*	Алгоритм ЭП

Поля объекта Получение результата модификации ЭП.extensionsCertificateInfo.value

Поле	Тип данных	Описание
Получение результата модификации ЭП	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*	Признак электронной печати

Поля объекта Получение результата модификации ЭП.Получение результата модификации ЭП.value.personalData.value

Поле	Тип данных	Описание
customId	Object*	Внешний идентификатор
passport	Object*	Паспортные данные
drfou	Object*	Регистрационный номер учетной карточки плательщика налогов
edrpou	Object*	Код ЕДПРОУ
eddrun	Object*	Уникальный номер записи в ЕГДР

Поля объекта типа Object*

Поле	Тип данных	Описание
description	String	Описание поля на языке, который выбран пользователем в Сервисе
value	[Object, String, Boolean, Number, Array, null]	Значение поля

Пример объекта signerInfo

{
    "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

$.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;
    }
})

Page tree