Page History

Запрос служит для получения профилей генерации ключей, которые используются Сервисом для генерации новых ключей. Запрос может быть выполнен в режиме работы "Без ключейЗапит призначено для отримання профілів генерації ключів, які використовуються Сервісом для генерації нових ключів. Запит може бути виконано у режимі роботи "Без ключів".

URL-

...

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

https://local.cipher.kiev.ua:9090/api/v1/generator/keysProfiles

Метод

GET

...

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

ОтсутствуютВідсутні

...

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

...

запиту

ОтсутствуетВідсутні

...

Відповідь

Код

ответа

відповіді	Content-type

Допустимые параметрыПример содержимого

Допустимі параметри	Приклад вмісту
200	application/json	Array	[ {...}, {...}, {...} ]
503	application/json	message	{

    "message" : "

Сервис

Сервіс

хранения

зберігання

данных

даних не

запущен

запущено." }
500	application/json	message failureCause	{

    "message" : "

Ошибка

Помилка при

загрузке

завантажені

набора

набору

профилей

профілів

сертификатов

сертифікатів.",
    "failureCause" : ""
}

...

Параметри JSON

...

обʼєкта відповіді

Параметр	Тип

данных

даних

Описание

Опис
message	String

Описание результата проведения операции

Опис результату проведення операції
failureCause	String

Описание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭЦП ArrayМассив профилей генерации ключей

Опис причини виникнення помилки, яка виникла при виконанні запиту на перевірку ЕП
	Array	Масив профілів генерації ключів

Поля елемента масиву, який повертається у випадку успішного виконання запиту Поля элемента массива, который возвращается в случае успешного выполнения запроса

Anchor

	profileArray
	profileArray

Параметр	Тип

данных

даних

Описание

Опис
caption	String

Название профиля

Назва профілю
id	String

Идентификатор профиля

Ідентифікатор профілю
startKeysLifeDays	Number

Время действия стартовых ключей

Час дії стартових ключів
oid	String	OID

профиляПолучение профилей генерации ключей

профілю
fields	Array

Параметры

Параметри,

которые необходимы для создания ключей на основе данного профиля

які необхідні для створення ключів на основі даного профілю

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

Anchor

	fields
	fields

Поле	Тип

данных

даних

Описание

Опис
name	String

Идентификатор параметра

Ідентифікатор параметру
caption	String

Названия параметра

Назва параметру
default	String

Значение по-умолчанию

Значення за замовчуванням
optional	Boolean

Признак обязательного параметра

...

Ознака обовʼязкового параметру

Приклад масиву профілів генерації ключів

Code Block

[
  {
    "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": "ПАТ &quot;Кредобанк&quot;",
        "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": "ПАТ &quot;Кредобанк&quot;",
        "optional": false
      },
      {
        "name": "ORGANIZATIONAL_UNIT_NAME",
        "caption": "Підрозділ",
        "default": "Технологічні ключі",
        "optional": true
      },
      {
        "name": "EDRPOU",
        "caption": "Код ЄДРПОУ",
        "default": "",
        "optional": true
      },
      {
        "name": "MAIL",
        "caption": "элЕл.адреса",
        "default": "",
        "optional": false
      }
    ]
  }
]

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

Code Block

language	js

$.ajax({
    url: "https://local.cipher.kiev.ua:9090/api/v1/generator/keysProfiles",
    type: "GET",
    dataType: "json",
    cache: false
}).done(function (jsonResponse, textStatus, xhr) {
    keysProfiles = jsonResponse;
}).fail(function (xhr) {
    try {
        var jsonResponse = JSON.parse(xhr.responseText);
        message = jsonResponse.message;
        failureCause = jsonResponse.failureCause; 
    } catch (e) {
        message = (xhr.responseText == undefined) ? "Ошибка при получении профилей генерации ключей." : xhr.responseText;
    }
})

...

Page tree

Versions Compared

Old Version 2

New Version Current

Key

URL-

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

Метод

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

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

запиту

Відповідь

Параметри JSON

обʼєкта відповіді

Приклад масиву профілів генерації ключів

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