Запрос служит Запит служить для контроля состояния процесса асинхронной модификации ЭП. Если процесс находится в стадии выполнения будет возвращен стану процесу асинхронної модифікації ЕП. Якщо процес знаходиться на стадії виконання буде повернуто HTTP статус код 202, в случае успешного завершения - 200 с дополнительными данными об процессе модификации ЭП. В остальных случаях возвращаются соответствующие коды из серий 4хх и у випадку успішного завершення - 200 з додатковими даними про процес модифікації ЕП. В інших випадках повертаються відповідні коди з серії 4хх та 5хх.
URL-
...
адреса запиту
https://localhost:9094/api/v1/ticket/{uuid}/ds/modifier
Метод
GET
...
Параметри запиту
| uuid | StringИдентификатор | сессииІдентифікатор сесії |
...
Налаштовувані заголовки
...
запиту
ОтсутствуетВідсутні
...
Відповідь
| Код ответавідповіді | Content-type | Допустимые параметры | Допустимі параметри | Приклад вмістуПример содержимого |
|---|---|---|---|---|
| 200 | application/json | message modifyResults | { | |
| 202 | application/json | message | { | |
| 503 | application/json | message | { | |
| 400 | application/json | message | { | |
| 406 | application/json | message modifyResults failureCause | { |
...
Параметри 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 | ||||
|---|---|---|---|---|
|
| Поле | Тип данныхданих | ОписаниеОпис |
|---|---|---|
| ownerSurname | Object* | ФамилияПрізвище |
| ownerGivenname | Object* | Имя отчествоІмʼя, по батькові |
| ownerFullName | Object* | Полное имяПовне імʼя |
| ownerCountry | Object* | СтранаКраїна |
| ownerRegion | Object* | Область |
| ownerCity | Object* | ГородНаселений пункт |
| ownerAddress | Object* | Почтовый адресПоштова адреса |
| ownerSerialNumber | Object* | Серийный Серійний номер владельцавласника |
| ownerPosition | Object* | ДолжностьПосада |
Поля объектаобʼєкта
Получение результата модификации ЭПsignerInfo.issuerCertificateInfo.valueAnchor issuerCertificateInfo issuerCertificateInfo
| Поле | Тип данныхданих | ОписаниеОпис |
|---|---|---|
| issuerOrganization | Object* | ОрганизацияОрганізація |
| issuerDepartment | Object* | ПодразделениеПідрозділ |
| issuerFullName | Object* | Полное имяПовне імʼя |
| issuerCountry | Object* | СтранаКраїна |
| issuerRegion | Object* | Область |
| issuerCity | Object* | ГородНаселений пункт |
| issuerAddress | Object* | Почтовый адресПоштова адреса |
| issuerSerialNumber | Object* | Серийный Серійний номер издателявласника |
Поля объектаобʼєкта
Получение результата модификации ЭПsignerInfo.publicKeyCertificateInfo.valueAnchor publicKeyCertificateInfo publicKeyCertificateInfo
| Поле | Тип данныхданих | ОписаниеОпис |
|---|---|---|
| publicKey | Object* | Открытый Відкритий ключ |
| dsAlgorism | Object* | Алгоритм ЭПЕП |
Поля объектаобʼєкта
Получение результата модификации ЭПsignerInfo.extensionsCertificateInfo.valueAnchor extensionsCertificateInfo extensionsCertificateInfo
| Поле | Тип данныхданих | Описание | Опис |
|---|---|---|---|
| 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* | Признак электронной печатиОзнака електронної печатки |
Поля объектаобʼєкта
Получение результата модификации ЭП.Получение результата модификации ЭПsignerInfo.extensionsCertificateInfo.value.personalData.value Anchor personalData personalData
| Поле | Тип данныхданих | ОписаниеОпис |
|---|---|---|
| customId | Object* | Внешний идентификаторЗовнішній ідентифікатор |
| passport | Object* | Паспортные данныеПаспортні дані |
| drfou | Object* | Регистрационный номер учетной карточки плательщика налоговРеєстраційний номер облікової картки платника податків |
edrpou | Object* | Код ЕДПРОУЄДРПОУ |
eddrun | Object* | Уникальный Унікальний номер записи запису в ЕГДРЄДДР |
Поля объекта типа обʼєкта типу
| Anchor | ||||
|---|---|---|---|---|
|
| Поле | Тип данныхданих | ОписаниеОпис |
|---|---|---|
| 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"
},
"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 | ||
|---|---|---|
| ||
$.ajax({
url: "https://localhost:9094/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;
}
}) |
...