API для служби SmartSign
увага
API для служби працює тільки з файловими ключами
Люба операція вважається успішною, якщо отримана відповідь 200
Видалення ключа
Запит виконується методом DELETE у json форматі.
URI: /api/v1/key/{sn}
Параметри URI
Метод дозволяє передати в рядку запиту наступні параметри:
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
sn | string | Так | Серійний номер ключа |
Приклад запиту
/api/v1/key/{111111111}
Приклад успішної відповіді
У відповідь ви отримаєте код 200
Приклад не успішної відповіді
Відповідь: /api/v1/key/{111111111}
{
"message": "Відсутній ключ з номером: %7B111111111%7D",
"code": "A001"
}
Отримання списку всіх ключів
Запит виконується методом GET у json форматі.
URI: /api/v1/key
Приклад запиту
/api/v1/key
Параметри відповіді
Ім'я | Тип | Опис |
---|---|---|
ACTIVE | boolean | Стан ключа: |
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 форматі.
URI: /api/v1/key/{sn}?isDeactivate={isDeactivate}
Параметри URI
Метод дозволяє передати в рядку запиту наступні параметри:
Ім'я | Тип | Обов'язковий | Опис |
---|---|---|---|
sn | string | Так | Серійний номер ключа |
isDeactivate | boolean | Ні |
Приклад запиту
Активація ключа
/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"
}
Додавання нового ключа
Запит виконується методом POST у json або urlencoded форматі.
URI: /api/v1/key