Запит служить для контролю стану процесу асинхронної модифікації КЕП. Якщо процес знаходиться на стадії виконання буде повернуто HTTP статус код 202, у випадку успішного завершення - 200 з додатковими даними про процес модифікації КЕП. В інших випадках повертаються відповідні коди з серії 4хх та 5хх.
URL-адреса запиту
https://signer.cipher.kiev.ua/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 | Тип КЕП після виконання модифікації. Допустимі типи підпису після модифікації |
Поля об'єкта signerInfo.ownerCertificateInfo.value
| Поле | Тип даних | Опис |
|---|---|---|
| ownerSurname | Object* | Прізвище |
| ownerGivenname | Object* | Ім'я по батькові |
| ownerFullName | Object* | Повне ім'я |
| ownerCountry | Object* | Країна |
| ownerRegion | Object* | Область |
| ownerCity | Object* | Населений пункт |
| ownerAddress | Object* | Поштова адреса |
| ownerSerialNumber | Object* | Серійний номер власника |
| ownerPosition | Object* | Посада |
Поля об'єкта signerInfo.issuerCertificateInfo.value
| Поле | Тип даних | Опис |
|---|---|---|
| issuerOrganization | Object* | Організація |
| issuerDepartment | Object* | Підрозділ |
| issuerFullName | Object* | Повне ім'я |
| issuerCountry | Object* | Країна |
| issuerRegion | Object* | Область |
| issuerCity | Object* | Населений пункт |
| issuerAddress | Object* | Поштова адреса |
| issuerSerialNumber | Object* | Серійний номер власника |
Поля об'єкта signerInfo.publicKeyCertificateInfo.value
Поля об'єкта 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* | Ознака електронної печатки |
Поля об'єкта signerInfo.extensionsCertificateInfo.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"
}
}
}
}
}
]
}