Запит призначено для отримання профілів генерації ключів, які використовуються Сервісом для генерації нових ключів. Запит може бути виконаним в режимі роботи "Без ключів".
URL-адреса запиту
https://local.cipher.kiev.ua:9091/api/v1/generator/keysProfiles
Метод
GET
Параметри запиту
Відсутні
Налаштовувані заголовки запиту
Відсутні
Відповідь
| Код відповіді | Content-type | Допустимі параметри | Приклад вмісту |
|---|---|---|---|
| 200 | application/json | Array | [ {...}, {...}, {...}] |
| 503 | application/json | message | {"message" : "Сервіс зберігання даних не запущено." } |
| 500 | application/json | message failureCause | { |
Параметри JSON об'єкта відповіді
Параметр | Тип даних | Опис |
|---|---|---|
| message | String | Опис результату проведення операції |
| failureCause | String | Опис причини виникнення помилки, яка виникла при виконанні запиту на перевірку ЕП |
| Array | Масив профівлів генерації ключів |
Поля елемента масиву, який повертається у випадку массива, который возвращаеуспішного виконання запиту
| Параметр | Тип даних | Опис |
|---|---|---|
| caption | String | Назва профілю |
| id | String | Ідентифікатор профілю |
| startKeysLifeDays | Number | Час дії стартових ключів |
| oid | String | OID профіля |
| fields | Array | Параметри, які необхідні для створення ключів на основі даного профілю |
Поля елемента масиву fields
| Поле | Тип даних | Опис |
|---|---|---|
| name | String | Ідентифікатор параметрів |
| caption | String | Назва параметру |
| default | String | Значення за замовчуванням |
| optional | Boolean | Ознака обов'язкового параметру |
Приклад масиву профілів генерації ключів
[
{
"caption": "За замовчуванням",
"id": 0,
"startKeysLifeDays": 14,
"oid": "1.3.6.1.4.1.7845.2.1.12.0",
"fields": [
{
"name": "COMMON_NAME",
"caption": "Повне ім'я",
"default": "",
"optional": true
},
{
"name": "COUNTRY_NAME",
"caption": "Країна",
"default": "ua",
"optional": false
},
{
"name": "GIVEN_NAME",
"caption": "Ім'я,по-батькові",
"default": "",
"optional": true
},
{
"name": "LOCALITY_NAME",
"caption": "Місто",
"default": "",
"optional": true
},
{
"name": "STATE_OR_PROVINCE_NAME",
"caption": "Область",
"default": "",
"optional": true
},
{
"name": "STREET_ADDRESS",
"caption": "Адреса",
"default": "",
"optional": true
},
{
"name": "SURNAME",
"caption": "Прізвище",
"default": "",
"optional": true
},
{
"name": "TITLE",
"caption": "Посада",
"default": "",
"optional": true
},
{
"name": "ORGANIZATION_NAME",
"caption": "Організація",
"default": "",
"optional": true
},
{
"name": "ORGANIZATIONAL_UNIT_NAME",
"caption": "Підрозділ",
"default": "",
"optional": true
},
{
"name": "POSTAL_CODE",
"caption": "Поштовий індекс",
"default": "",
"optional": true
},
{
"name": "DRFOU",
"caption": "Код ДРФО",
"default": "",
"optional": true
},
{
"name": "EDRPOU",
"caption": "Код ЄДРПОУ",
"default": "",
"optional": true
},
{
"name": "PASSPORT",
"caption": "№ паспорту",
"default": "",
"optional": true
},
{
"name": "MAIL",
"caption": "Ел.адреса",
"default": "",
"optional": true
},
{
"name": "CARD_ID",
"caption": "№ посвідчення",
"default": "",
"optional": true
},
{
"name": "UNZR",
"caption": "УНЗР",
"default": "",
"optional": true
}
]
},
{
"caption": "Співробітник банку",
"id": 3,
"startKeysLifeDays": 14,
"oid": "1.3.6.1.4.1.7845.2.1.12.3",
"fields": [
{
"name": "COMMON_NAME",
"caption": "Повне ім'я",
"default": "",
"optional": false
},
{
"name": "COUNTRY_NAME",
"caption": "Країна",
"default": "ua",
"optional": false
},
{
"name": "GIVEN_NAME",
"caption": "Ім'я,по-батькові",
"default": "",
"optional": false
},
{
"name": "LOCALITY_NAME",
"caption": "Місто",
"default": "",
"optional": false
},
{
"name": "STATE_OR_PROVINCE_NAME",
"caption": "Область",
"default": "",
"optional": false
},
{
"name": "STREET_ADDRESS",
"caption": "Адреса",
"default": "",
"optional": false
},
{
"name": "SURNAME",
"caption": "Прізвище",
"default": "",
"optional": false
},
{
"name": "EXTERNAL_USER_ID",
"caption": "Зовнішний ідентіфікатор",
"default": "",
"optional": false
},
{
"name": "TITLE",
"caption": "Посада",
"default": "",
"optional": false
},
{
"name": "ORGANIZATION_NAME",
"caption": "Організація",
"default": "ПАТ "Кредобанк"",
"optional": false
},
{
"name": "ORGANIZATIONAL_UNIT_NAME",
"caption": "Підрозділ",
"default": "",
"optional": false
},
{
"name": "DRFOU",
"caption": "Код ДРФО",
"default": "",
"optional": true
},
{
"name": "PASSPORT",
"caption": "№ паспорту",
"default": "",
"optional": false
},
{
"name": "MAIL",
"caption": "Ел.адреса",
"default": "",
"optional": false
},
{
"name": "UNZR",
"caption": "УНЗР",
"default": "",
"optional": true
}
]
},
{
"caption": "Технолог",
"id": 6,
"startKeysLifeDays": 14,
"oid": "1.3.6.1.4.1.7845.2.1.12.6",
"fields": [
{
"name": "COMMON_NAME",
"caption": "Повне ім'я",
"default": "",
"optional": false
},
{
"name": "COUNTRY_NAME",
"caption": "Країна",
"default": "ua",
"optional": false
},
{
"name": "GIVEN_NAME",
"caption": "Ім'я,по-батькові",
"default": "",
"optional": true
},
{
"name": "LOCALITY_NAME",
"caption": "Місто",
"default": "",
"optional": true
},
{
"name": "STATE_OR_PROVINCE_NAME",
"caption": "Область",
"default": "",
"optional": true
},
{
"name": "STREET_ADDRESS",
"caption": "Адреса",
"default": "",
"optional": true
},
{
"name": "SURNAME",
"caption": "Прізвище",
"default": "",
"optional": true
},
{
"name": "EXTERNAL_USER_ID",
"caption": "Зовнішний ідентіфікатор",
"default": "",
"optional": true
},
{
"name": "TITLE",
"caption": "Посада",
"default": "",
"optional": true
},
{
"name": "ORGANIZATION_NAME",
"caption": "Організація",
"default": "ПАТ "Кредобанк"",
"optional": false
},
{
"name": "ORGANIZATIONAL_UNIT_NAME",
"caption": "Підрозділ",
"default": "Технологічні ключі",
"optional": true
},
{
"name": "EDRPOU",
"caption": "Код ЄДРПОУ",
"default": "",
"optional": true
},
{
"name": "MAIL",
"caption": "Ел.адреса",
"default": "",
"optional": false
}
]
}
]