Page History

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

URL-

...

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

https://localhost:9092signer.cipher.kiev.ua/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	Тип

ЭП после выполнения модификации. Допустимые типы подписи после модификации.

ЕП після виконання модифікації. Допустимі типи підпису після модифікації

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

Anchor

	ownerCertificateInfo
	ownerCertificateInfo

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

Поле	Тип

данных

даних

Описание

Опис
ownerSurname	Object*

Фамилия

Прізвище
ownerGivenname	Object*

Имя отчество

Ім'я по батькові
ownerFullName	Object*

Полное имя

Повне ім'я
ownerCountry	Object*

Страна

Країна
ownerRegion	Object*	Область
ownerCity	Object*

Город

Населений пункт
ownerAddress	Object*

Почтовый адрес

Поштова адреса
ownerSerialNumber	Object*

Серийный

Серійний номер

владельца

власника
ownerPosition	Object*

Должность

Посада

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

Anchor

	issuerCertificateInfo
	issuerCertificateInfo

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

Поле	Тип

данных

даних

Описание

Опис
issuerOrganization	Object*

Организация

Організація
issuerDepartment	Object*

Подразделение

Підрозділ
issuerFullName	Object*

Полное имя

Повне ім'я
issuerCountry	Object*

Страна

Країна
issuerRegion	Object*	Область
issuerCity	Object*

Город

Населений пункт
issuerAddress	Object*

Почтовый адрес

Поштова адреса
issuerSerialNumber	Object*

Серийный

Серійний номер

издателя

власника

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

Anchor

	publicKeyCertificateInfo
	publicKeyCertificateInfo

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

Поле	Тип

данных

данх

Описание

Опис
publicKey	Object*

Открытый

Відкритий ключ
dsAlgorism	Object*	Алгоритм

ЭП

ЕП

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

Anchor

	extensionsCertificateInfo
	extensionsCertificateInfo

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

Поле	Тип

данных

даних

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

Опис
personalData	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*	Ознака електронної печатки

Поля об'єкта

Anchor

	personalData
	personalData

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

Поле	Тип

данных

даних

Описание

Опис
customId	Object*

Внешний идентификатор

Зовнішній ідентифікатор
passport	Object*

Паспортные данные

Паспортні дані
drfou	Object*

Регистрационный номер учетной карточки плательщика налогов

Реєстраційний номер облікової картки платників податків
edrpou	Object*	Код

ЕДПРОУ

ЄДРПОУ
eddrun	Object*

Уникальный

Унікальний номер

записи

запису в

ЕГДР

ЄДР

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

Anchor

	CertObject
	CertObject

Object*

Поле	Тип

данных

даних

Описание

Опис
description	String

Описание

Опис поля на

языке, который выбран пользователем в Сервисе

мові, який обрано користувачем у Сервісі
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

language	js

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

Page tree

Versions Compared

Old Version 1

New Version Current

Key

URL-

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

Метод

Параметри запиту

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

запиту

Відповідь

Параметри JSON об'єкта відповіді

Пример кода на JavaScript + jQuery 2.2.4