Управління зовнішніми інтеграціями

ЗМІСТ

1. Загальні положення
2. Типи інтеграційної взаємодії
- 2.1. Обмін даними за допомогою SOAP через програмний інтерфейс "Трембіта"
- 2.2. Обмін даними з іншими системами за допомогою REST
3. Додаткові відеоматеріали

🌐 Цей документ доступний українською та англійською мовами. Використовуйте перемикач у правому верхньому куті, щоб змінити версію.

1. Загальні положення

Управління зовнішніми інтеграціями відіграє критичну роль у забезпеченні інформаційного обміну між різними системами та джерелами даних.

REST (Representational State Transfer) та SOAP (Simple Object Access Protocol) є двома основними протоколами взаємодії з іншими реєстрами та системами, що використовуються для передачі даних.

REST, що базується на протоколі HTTP, дозволяє взаємодіяти з іншими реєстрами на Платформі та зовнішніми системами шляхом передачі запитів та отримання відповідей у форматі JSON.
SOAP, з іншого боку, використовує XML-схему для взаємодії з іншими системами, дозволяючи викликати методи й передавати параметри використовуючи певний набір правил.

Основні принципи інтеграції з іншими реєстрами та системами:

Регламент реєстру не містить налаштувань, які залежать від "оточення"/екземпляра реєстру, щоб забезпечити однаковість налаштувань для всіх екземплярів.
Регламент реєстру не містить конфіденційних даних ні в якій формі, щоб запобігти їх неправомірному використанню.
Налаштування параметрів зовнішніх інтеграцій не дублюється та використовується централізовано, що забезпечує консистентність налаштувань.
Додавання зовнішніх систем для інтеграції з реєстром не потребує ручних дій налаштування мережевих політик для забезпечення швидкої та безпечної інтеграції.
Секрети з параметрами доступу до зовнішніх систем зберігаються у захищеному сховищі сервісу управління секретами HashiCorp Vault, щоб запобігти несанкціонованому доступу до цих даних.
Адміністратор реєстру налаштовує інтеграції з іншими системами на рівні екземпляра реєстру в адміністративній панелі Control Plane, включаючи протокол інтеграції, адресу, протокол аутентифікації, секрети тощо.
Адміністратор реєстру відповідає за ротацію секретів та параметрів доступу до зовнішніх систем.
Адміністратор забезпечує мінімальну попередню конфігурацію на рівні регламенту для використання зовнішніх інтеграцій у бізнес-процесах.
Міжреєстрова інтеграція через "Трембіту" здійснюється за допомогою типових розширень-конекторів, які містяться у реєстрі, і не вимагає додаткової конфігурації на рівні регламенту.
Інтеграція зі сторонніми (3rd-party) системами потребує додаткової конфігурації на рівні регламенту, зокрема необхідно визначити перелік операцій та їх типів, які використовує реєстр через типове інтеграційне розширення-конектор Connect to external system (REST-конектор).

Для версій Платформи 1.9.3 та вище основні налаштування виконуються на рівні екземпляра реєстру у консолі Control Plane.

Для версій 1.9.2 та нижче усі налаштування виконуються на рівні регламенту реєстру.

Налаштування взаємодії із зовнішніми системами можливе лише при редагуванні реєстру.

За замовчуванням при розгортанні реєстру, створюється три не налаштовані точки для сервісів ШБО "Трембіта" й одна для зовнішньої системи — "Дія".

2. Типи інтеграційної взаємодії

Платформа дозволяє гнучко інтегруватися з іншими реєстрами та системами й підтримує 2 типи взаємодії:

SOAP API: Взаємодія через інтерфейси ШБО "Трембіта" за допомогою SOAP-інтеграційних конекторів. Це основний тип інтеграційної взаємодії.

Екземпляр ШБО встановлюється один для всіх реєстрів, у тому ж центрі обробки даних (ЦОД), що й екземпляр Платформи. Кожна подібна зовнішня система повинна мати встановлений екземпляр ШБО на своїй стороні та бути зареєстрованим учасником єдиного захищеного простору, який називають СЕВ ДЕІР "Трембіта", де основним протоколом інтеграційної взаємодії є SOAP.
REST API: Взаємодія з іншими реєстрами на Платформі та зовнішніми системами поза її межами через REST-інтерфейси. Це додатковий тип підключення розширення можливостей інтеграційної взаємодії.

2.1. Обмін даними за допомогою SOAP через програмний інтерфейс "Трембіта"

ШБО "Трембіта" є програмним інтерфейсом, який дозволяє взаємодіяти з реєстрами, які до нього підключені, зокрема ЄДР, ДРАЦС, або ЄІБДВПО.

Загальний механізм взаємодії з реєстрами через ШБО "Трембіта" представлено на діаграмі нижче.

Зображення 1. Загальний механізм взаємодії з реєстрами через ШБО "Трембіта"

Для успішної взаємодії з реєстрами через ШБО "Трембіта", необхідно дотримуватися вимог щодо формату даних та забезпечити їх правильну обробку в системі. Обмін даними між реєстрами-учасниками СЕВ ДЕІР "Трембіта" відбувається за протоколом SOAP (Simple Object Access Protocol) у форматі XML.

SOAP-взаємодія між реєстрами через ШБО "Трембіта" є надійним і безпечним методом передачі даних. Дані передаються у зашифрованому вигляді, що забезпечує їх конфіденційність. Також ШБО "Трембіта" дозволяє перевіряти правдивість запитів, що запобігає можливим атакам.

Щоб налаштувати взаємодію з реєстрами через ШБО "Трембіта", Вам необхідно:

Зареєструвати підсистему нового реєстру на ШБО "Трембіта" Платформи:
- Зареєструвати свою організацію в системі "Трембіта" та вказати необхідні реквізити.
- Узгодити та отримати доступ до необхідних сервісів СЕВ ДЕІР "Трембіта".
  
  Детальніше — див. на сторінці Реєстрація підсистеми нового реєстру на ШБО "Трембіта" Платформи
  
  Якщо підсистема зареєстрована, перейдіть до наступного кроку.
Налаштувати взаємодію з реєстрами, до яких Ви отримали доступ, в адміністративній панелі Control Plane.

Детальніше — див. на сторінці Налаштування взаємодії з реєстрами через ШБО "Трембіта" у Control Plane.
Змоделювати обмін даними з іншими реєстрами та їх сервісами через ШБО "Трембіта" у бізнес-процесах за допомогою SOAP-інтеграційних конекторів.

Детальніше — див. на сторінці Типові інтеграційні SOAP-конектори до інших реєстрів.

2.2. Обмін даними з іншими системами за допомогою REST

Інтеграційна REST-взаємодія реєстрів з іншими реєстрами на Платформі та зовнішніми системами означає можливість передачі даних з одного реєстру в інший або між зовнішніми системами за допомогою REST-запитів.

REST (Representational State Transfer) — це стиль архітектури програмного забезпечення для створення вебсервісів. У REST-архітектурі існує ряд обмежень, які забезпечують взаємодію між клієнтом та сервером. REST використовує HTTP-протокол для передачі даних.

Така взаємодія використовує програмні інтерфейси REST API та HTTP-запити для отримання інформації. Інтерфейс може забезпечити доступ до функціональності реєстру, а також надати можливість зчитувати та змінювати дані. Передача даних здійснюється у форматі JSON. Дані можуть бути передані в обидві сторони — від зовнішньої системи до реєстру або від реєстру до зовнішньої системи.

Щоб налаштувати взаємодію з іншими системами за допомогою REST, Вам необхідно:

Налаштувати взаємодію з реєстрами в адміністративній панелі Control Plane.

Детальніше — див. на сторінці Налаштування взаємодії з іншими системами у Control Plane.
Виконати мінімальні налаштування на рівні регламенту.

Детальніше — див. на сторінці REST-конектор: налаштування регламенту.
Змоделювати обмін даними з іншими системами у бізнес-процесах за допомогою інтеграційного REST конектора Connect to external system.

Детальніше — див. на сторінці REST-конектор: моделювання у бізнес-процесі.

Розгорнуту інформацію щодо можливостей REST-інтеграції ви можете отримати на сторінці Інтеграційна REST-взаємодія реєстрів з іншими реєстрами на Платформі та зовнішніми системами.