You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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

URL-адрес запроса

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

Метод

GET

Параметры запроса

Отсутствуют

Настраиваемые заголовки запроса

Отсутствует

Ответ
Код ответаContent-typeДопустимые параметрыПример содержимого
200application/jsonArray
[
    {...}, {...}, {...}
] 
503application/jsonmessage
{
    "message" : "Сервис хранения данных не запущен." 
}
500application/jsonmessage
failureCause

{
    "message" : "Ошибка при загрузке набора профилей сертификатов.",
    "failureCause" : ""
}
Параметры JSON объекта ответа
Параметр
Тип данных
Описание
messageStringОписание результата проведения операции
failureCause StringОписание причины возникновения ошибки, которая возникла при выполнении запроса на проверку ЭП

ArrayМассив профилей генерации ключей

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

ПараметрТип данныхОписание
captionStringНазвание профиля
idStringИдентификатор профиля
startKeysLifeDaysNumberВремя действия стартовых ключей
oidStringOID профиля
Получение профилей генерации ключейArrayПараметры, которые необходимы для создания ключей на основе данного профиля

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

ПолеТип данныхОписание
nameStringИдентификатор параметра
captionStringНазвания параметра
defaultStringЗначение по-умолчанию
optionalBooleanПризнак обязательного параметра
Пример массива профилей генерации ключей
[
  {
    "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
      }
    ]
  }
]
Пример кода на JavaScript + jQuery 2.2.4
$.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;
    }
})



  • No labels