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

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

URI: /api/v1/key

Підтримуються два типи ключів: file (файловий) та cloud (хмарний).

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

Ім'я	Тип	Обов'язковий	Опис
type	string	Ні	Тип ключа: file — файловий (за замовчуванням) cloud — хмарний Якщо параметр не передано — вважається file
key	string	Так, для file	Шлях до файлу ключа. Для хмарного ключа не передається
publisher	string	Так	Видавець ключа. Для файлового ключа (type = `"file"`) параметр publisher може містити будь-якого видавця, обмеження списком АЦСК не застосовується. Для хмарного ключа (type = `"cloud"`) необхідно обрати одного з підтримуваних надавачів: – КНЕДП ТОВ «Вчасно Сервіс» – КНЕДП ТОВ «АМО ФІНТЕХ» – КНЕДП «eSign» ТОВ «Ілайф»
pass	string	Так	Пароль до ключа
inn	string	Ні, для cloud	ІПН власника ключа фізичної особи, ЄДРПОУ — для юрособи. Якщо не передано — використовується значення edrpou
edrpou	string	Так, для cloud	Код ЄДРПОУ організації
serial	string	Так, для cloud	Серійний номер ключа

Увага!

Для файлового ключа (type = "file"):

обов'язкові key, publisher, pass
поля хмарного ключа (inn, edrpou, serial) можна не передавати

Для хмарного ключа (type = "cloud"):

обов’язкові publisher, pass, edrpou, serial
поле key не передається і не використовується

Приклад запиту для файлового ключа

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

Приклад запиту для хмарного ключа

КНЕДП "eSign" ТОВ "Ілайф"

Запит: /api/v1/key
{
  "type": "cloud",
  "publisher": "КНЕДП \"eSign\" ТОВ \"Ілайф\"",
  "pass": "222222",
  "inn": "21032333",
  "edrpou": "21032333",
  "serial": "011555"
}

КНЕДП ТОВ "Вчасно Сервіс"

Запит: /api/v1/key
{
  "type": "cloud",
  "publisher": "КНЕДП ТОВ \"Вчасно Сервіс\"",
  "pass": "222222",
  "inn": "21032333",
  "edrpou": "21032333",
  "serial": "011555"
}

КНЕДП ТОВ "АМО ФІНТЕХ"

Запит: /api/v1/key
{
  "type": "cloud",
  "publisher": "КНЕДП ТОВ \"АМО ФІНТЕХ\"",
  "pass": "222222",
  "inn": "21032333",
  "edrpou": "21032333",
  "serial": "011555"
}

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

Відповідь: /api/v1/key
{
    "message": "OK"
}

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

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

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

Для хмарних ключів (type = "cloud") підтримуються лише такі АЦСК:

КНЕДП ТОВ "Вчасно Сервіс"
КНЕДП ТОВ "АМО ФІНТЕХ"
КНЕДП "eSign" ТОВ "Ілайф"

Для файлових ключів (type = "file") список АЦСК не виводиться — можна використовувати будь-якого видавця.