5.2. Керування REST-сервісами
Механізм публікації REST-сервісів, що працюють без використання ЛК ПМДПД, та REST-сервісів, що працюють з використанням ЛК ПМДПД, наведено на рисунку 5.5 (а та б відповідно).
Рисунок 5.5 – Механізм публікації REST-сервісів на ШБО: а – без використання ЛК ПМДПД, б – з використанням ЛК ПМДПД
5.2.1. Публікація REST-сервісу без використання ЛК ПМДПД
Процес публікації REST-сервісів, що працюють без використання ПМДПД в нотації IDEF0, з усіма відомостями, які необхідні Адміністратору вебсервісів наведено на рисунку 5.6.
Рисунок 5.6 – Процес публікації REST-сервісів які працюють без використання ЛК ПМДПД в нотації IDEF0
Щоб опублікувати REST-сервіс на відповідній підсистемі необхідно:
1. Перейти на вкладку «Клієнти сервера безпеки»:
2. Відкрити потрібну підсистему і перейти на вкладку «REST APIs».
3. Натиснути на кнопку «Додати REST API»:
4. Ввести наступні параметри у діалоговому вікні, що відкриється:
- Базова URL – статична (незмінна) частина URL-адреси кінцевого REST API (endpoint сервісу).
Примітка. URL-адресу кінцевого REST API (endpoint сервісу) надає розробник сервісу.
- Код сервісу – ідентифікатор сервісу у системі «Трембіта», він встановлюється у довільній формі з використанням латинських літер та цифр.
- Версія сервісу – версія сервісу у системі «Трембіта». Встановлюється у довільній формі (наприклад, v1) з використанням латинських літер, цифр, крапки.
5. Натиснути на кнопку «ОК». Сервіс буде додано до переліку опублікованих REST-сервісів.
За замовчуванням щойно доданий REST-сервіс додається у вимкненому стані. Для того, щоб активувати його необхідно виділити даний сервіс (що позначається червоним текстом) і натиснути на кнопку «Увімкнути»:
5.2.2. Налаштування прав доступу до REST-сервісів
Для того, щоб до опублікованого вебсервісу можна було робити запити, необхідно надати відповідні права доступу для інших Суб’єктів електронної взаємодії (їх підсистем). Процес надання доступу до REST-сервісів в нотації IDEF0, з усіма необхідними Адміністратору вебсервісів відомостями наведено на рисунку 5.7.
Рисунок 5.7 – Процес задання прав доступу до REST-сервісів в нотації IDEF0
Для надання права доступу до REST-сервісу необхідно:
1. Перейти на вкладку «Клієнти серверу безпеки».
2. Відкрити потрібну підсистему і перейти на вкладку «REST APIs».
3. Виділити необхідний сервіс.
4. Натиснути на кнопку «Права доступу»:
5. Натиснути на кнопку «Додати об'єкти»:
6. Знайти та виділити підсистему, якій необхідно надати права доступу до сервісу (знайти потрібну підсистему можна, наприклад, шляхом введення коду ЄДРПОУ відповідного Суб’єкта електронної взаємодії, якому вона належить, або введення коду самої підсистеми і натискання на кнопку пошуку).
7. Натиснути на кнопку «Додати обране»:
Суб’єкт електронної взаємодії, якому надано права доступу, та його підсистема відобразяться у вікні «ACL для сервісу»..
5.2.3. Зміна параметрів REST-сервісу
Наступні параметри REST-сервісу, які можна налаштувати на ШБО:
- URL сервісу – URL-адреса, на яку спрямовуються запити до певного сервісу (endpoint сервісу).
- Тайм-аут – максимальний час у секундах, який шлюз безпечного обміну чекає на відповідь від сервісу, перш, ніж повернути помилку очікування.
- Перевірка сертифікату TLS – встановлюється для активації перевірки сертифікату при встановленні з’єднання TLS.
Примітка. Це поле стає активним, коли URL-адреса серверу починається з «https://». Якщо перевірка ввімкнена, відповідний сертифікат повинен бути завантажений на вкладці «Внутрішні сервери» відповідної підсистеми, згідно п.2 розділу 4.2.5 даної інструкції.
Щоб змінити параметри сервісу необхідно:
1. Виділити необхідний REST-сервіс.
2. Натиснути на кнопку «Редагувати»:
3. Налаштувати параметри сервісу у вікні, що відкриється:
4. Натиснути на кнопку «OK», щоб застосувати налаштовані параметри.
5.2.4. Публікація REST-сервісу з використанням ЛК ПМДПД
Процес публікації REST-сервісів, які працюють з використанням ЛК ПМДПД в нотації IDEF0, з усіма необхідними Адміністратору вебсервісів відомостями наведено на рисунку 5.8.
Рисунок 5.8 – Процес публікації SOAP-сервісів які працюють з використанням ЛК ПМДПД в нотації IDEF0
Для публікації сервісу з використанням ЛК ПМДПД необхідно:
- Опублікувати сервіс відповідно до розділу 5.2.1 даної інструкції.
- Сповістити Адміністратора Локального компоненту ПМДПД про те, що вебсервіс опубліковано на ШБО та передати йому інформацію про даний сервіс, зокрема, його endpoint, назву, призначення тощо.
- Адміністратор Локального компоненту ПМДПД повинен на основі отриманих даних створити сервісну декларацію для даного сервісу засобами ЛК ПМДПД та надати Адміністратору вебсервісів новий endpoint сервісу.
- Адміністратор вебсервісів повинен замінити endpoint доданого сервісу на endpoint, який передано Адміністратором Локального компоненту ПМДПД. Процес заміни можна виконати відповідно до настанов розділу 5.2.3 даної інструкції.
5.2.5. Відключення REST-сервісу
Іноді існує необхідність тимчасового відключення REST-сервісу (наприклад, при проведенні регламентних робіт, відновленні працездатності сервісу тощо), для цього необхідно:
1. Перейти на вкладку «Клієнти серверу безпеки».
2. Відкрити потрібну підсистему і перейти на вкладку «REST APIs».
3. Виділити потрібний сервіс та натиснути на кнопку «Відключити»:
4. Заповнити поле «Повідомлення для клієнтів, які роблять запити на вимкнення REST APIs» та натиснути на кнопку «ОК»:
5.2.6. Видалення REST-сервісу
Щоб видалити REST-сервіс необхідно:
1.Перейти на вкладку «Клієнти серверу безпеки».
2. Відкрити потрібну підсистему і перейти на вкладку «REST APIs».
3. Обрати потрібний сервіс та натиснути на кнопку «Видалити»:
4. Підтвердити видалення, натиснувши на відповідну кнопку в діалоговому вікні:
