API для служби SmartSign

увага

API для служби SmartSign використовується для керування файловими ключами на локальному ПК.
Будь-яка операція вважається успішною, якщо отримана відповідь 200

Отримання списку всіх ключів

Запит виконується методом GET у json форматі.

URI: /api/v1/key

Приклад запиту

/api/v1/key

Параметри відповіді

Ім'я	Тип	Опис
ACTIVE	boolean	Стан ключа: true — активований false — не активований
SN	string	Серійний номер ключа
EDRPOU	string	Код ЕДРПОУ
FIO	string	ПІБ
INN	string	ІНН
DURATION	string	Дата кінця дії ключа
KEY_PATH	string	Шлях до ключа
CREATOR	string	Видавець ключа

Приклад успішної відповіді

Відповідь: /api/v1/key
[
  {
    "ACTIVE": false,
    "SN": "2B6C7***9E102",
    "EDRPOU": "",
    "FIO": "ІВАНОВ ІВАН ІВАНОВИЧ",
    "INN": "11111111",
    "DURATION": "20.12.2022",
    "KEY_PATH": "E:\\pb_111111.jks",
    "CREATOR": "АЦСК АТ КБ «ПРИВАТБАНК»"
  },
  {
    "ACTIVE": false,
    "SN": "24819***A2804",
    "EDRPOU": "",
    "FIO": "ПЕТРОВ ПЕТРО ПЕТРОВИЧ",
    "INN": "2222222",
    "DURATION": "24.05.2024",
    "KEY_PATH": "E:\\pb_222222.jks",
    "CREATOR": "АЦСК АТ КБ «ПРИВАТБАНК»"
  }
]

Додавання нового ключа

Запит виконується методом POST у json або urlencoded форматі.

URI: /api/v1/key

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

Ім'я	Тип	Обов'язковий	Опис
key	string	Так	Шлях до файлу ключа
publisher	string	Так	Видавець ключа (брати строго зі списку видавців)
pass	string	Так	Пароль до ключа

Приклад запиту

Запит: /api/v1/key
{
    "key": "c:\test.dat",
    "publisher": "КНЕДП ДПС",
    "pass": "111"
}

Приклад успішної відповіді

Відповідь: /api/v1/key
{
    "SN": "2B6C7***9E102",
    "FIO": "ІВАНОВ ІВАН ІВАНОВИЧ",
    "NAME_EDRPOU": "",
    "INN": "11111111",
    "EDRPOU": "",
    "DURATION": "20.12.2022",
}

Приклад не успішної відповіді

Відповідь: /api/v1/key
{
    "message": "Відсутній файл: c:\test.dat",
    "code": "A004"
}

Активація / деактивація ключа

Запит виконується методом POST у json форматі.

URI: /api/v1/key/{sn}?isDeactivate={isDeactivate}

Параметри URI

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'я	Тип	Обов'язковий	Опис
sn	string	Так	Серійний номер ключа
isDeactivate	boolean	Ні	true — деактивація ключа false — активація ключа Також для активації ключа можна не передавати даний параметр

Приклад запиту

Активація ключа

/api/v1/key/{111111111}?isDeactivate=false або /api/v1/key/{111111111}

Деактивація ключа

/api/v1/key/{111111111}?isDeactivate=true

Приклад успішної відповіді

У відповідь ви отримаєте код 200

Приклад не успішної відповіді

Відповідь: /api/v1/key/{111111111}?isDeactivate=true
{
    "message": "Відсутні дані по ключу: 111111111",
    "code": "A001"
}

Видалення ключа

Запит виконується методом DELETE у json форматі.

URI: /api/v1/key/{sn}

Параметри URI

Метод дозволяє передати в рядку запиту наступні параметри:

Ім'я	Тип	Обов'язковий	Опис
sn	string	Так	Серійний номер ключа

Приклад запиту

/api/v1/key/{111111111}

Приклад успішної відповіді

У відповідь ви отримаєте код 200

Приклад не успішної відповіді

Відповідь: /api/v1/key/{111111111}
{
    "message": "Відсутній ключ з номером: %7B111111111%7D",
    "code": "A001"
}

Список видавців

КНЕДП ДПС
"Дія". Кваліфікований надавач електронних довірчих послуг
КНЕДП ЦСК Укрзалізниці
КНЕДП "MASTERKEY" ТОВ "АРТ-МАСТЕР"
КНЕДП ДП "УСС"
КНЕДП АТ "УКРСИББАНК"
КНЕДП АЦСК АТ КБ "ПРИВАТБАНК"
КНЕДП АЦСК АТ "Альфа-Банк"
КНЕДП АТ "СЕНС БАНК"
КНЕДП Акціонерного товариства “КРЕДІ АГРІКОЛЬ БАНК”
КНЕДП АТ "ПУМБ"
КНЕДП ТОВ "ДЕПОЗИТ САЙН"
КНЕДП ТОВ "Вчасно Сервіс"
КНЕДП “ЦСК Збройних Сил України”
КНЕДП "Військова частина 2428" ДПСУ
КНЕДП "АЦСК ринку електричної енергії"
КНЕДП - АЦСК МВС України
КНЕДП Служби зовнішньої розвідки України
АЦСК Національного банку України
КНЕДП АТ "ПРАВЕКС БАНК"
КНЕДП АТ "ТАСКОМБАНК"
КНЕДП ТОВ "Центр сертифікації ключів "Україна"
КНЕДП Казначейства
КНЕДП АТ "Ощадбанк"
КНЕДП органів прокуратури України
КНЕДП СБ України
КНЕДП ЦЕЗАРІС TOB "Інтер-Метл"
КНЕДП "eSign" ТОВ "Ілайф"
КНЕДП АТ "БАНК АЛЬЯНС"
КНЕДП АБ "УКРГАЗБАНК"