Адміністратор може налаштовувати інтеграцію системи із зовнішніми АРІ, для цього в панелі навігації «Студія» треба обрати ярлик «Інтеграція», далі обрати «Зовнішні АРІ» та натиснути кнопку «Додати».
Рис. 2.9.1.1. Зовнішні АРІ
Необхідно заповнити поля, опис яких наведено у таблиці.
Рис. 2.9.1.2. Зовнішні АРІ – Властивості
Таблиця. Властивості зовнішнього АРІ
|
Назва поля |
Опис |
|
Код* |
Унікальний код зовнішнього АРІ |
|
Назва* |
Відображувана назва зовнішнього АРІ |
|
Опис |
Короткий опис зовнішнього АРІ |
Після заповнення властивостей зовнішнього АРІ, адміністратор може налаштувати зв’язок системі із зовнішніми серверами. Для виклику методів потрібна інформація про сервер, де розгорнуто API, тому налаштуйте принаймні один сервер. Якщо API розгорнуто на декількох серверах, можливо налаштувати більше одного сервера. Для цього необхідно перейти на вкладку «Сервери» і натиснути на кнопку «+ Додати сервер».
Рис. 2.9.1.3. Зовнішні АРІ – Сервери
Необхідно заповнити поля, опис яких наведено у таблиці.
Рис. 2.9.1.4. Зовнішні АРІ – Додати сервер
Таблиця. Додати сервер для зовнішнього АРІ
|
Назва поля |
Опис |
|
URL адреса сервера* |
URL адреса сервера буде додаватись у якості префікса в URL кожного метода API |
|
Назва* |
Відображувана назва сервера |
|
Опис |
Короткий опис сервера |
Для кожного з серверів є можливість налаштувати тип авторизації. Для цього необхідно натиснути кнопку «Налаштувати» після цього вибрати необхідний тип авторизації.
Рис. 2.9.1.5. Зовнішні АРІ – Налаштування авторизації
Адміністратор може налаштувати методи взаємодії системі із зовнішніми серверами. Для цього необхідно перейти на вкладку «Методи» і натиснути на кнопку «+ Додати метод». Для виклику методів потрібна інформація про сервер, де розгорнуто API, тому налаштуйте принаймні один сервер.
Рис. 2.9.1.6. Зовнішні АРІ – Методи
Необхідно заповнити поля, опис яких наведено у таблиці.
Рис. 2.9.1.7. Зовнішні АРІ – Додати метод
Таблиця. Додати метод для зовнішнього АРІ
|
Назва поля |
Опис |
|
HTTP метод* |
Вибір типу HTTP методу API:
|
|
Шлях* |
Налаштування шляху. Для додавання параметра шляху, використовуйте синтаксис «з вусами», наприклад: {{pathParam}} |
|
Назва* |
Відображувана назва методу |
|
Опис |
Короткий опис методу |
Після створення методу необхідно налаштувати прив’язку даних які передаються та приймаються від зовнішньої системи.
Рис. 2.9.1.8. Зовнішні АРІ – прив’язка тіла запиту
Рис. 2.9.1.9. Зовнішні АРІ – прив’язка набору даних
При прив’язці необхідно задати назву змінної зовнішньої системи та поточної системи.
Рис. 2.9.1.10. Зовнішні АРІ – прив’язка змінних
Після налаштування методів є можливість протестувати їх роботу, для цього необхідно зберегти метод та натиснути кнопку «Викликати». Далі необхідно внести параметри тіла запиту, в прикладі це ID, та натиснути «Викликати». В таблиці «Набор даних» буде отримано результат запиту – відображені поля, налаштовані в «Прив’язування набору даних».
Рис. 2.9.1.10. Зовнішні АРІ – виклик методу
Виклик налаштованих методів можливий тільки з BPMN процесів за допомогою службової задачі. При виклику вказуються код зовнішньої системи, назва методу та перелік атрибутів – згідно налаштувань прив’язки методу.
Рис. 2.9.1.10. Зовнішні АРІ – виклик методу з системної BPMN задачі
При цьому ми вказуємо назви змінних поточної системи, які задані в налаштуваннях методу. В ці зміні ми передаємо значення змінних процесу, які в процес передаються з документу.
Рис. 2.9.1.11. Зовнішні АРІ – зв’язок змінних
В результаті відпрацювання методу буде отримана відповідь в форматі JSON, яку за допомогою скрипта в задачі BPMN можна перетворити на змінні процесу (див. документацію Camunda)
Рис. 2.9.1.12. Зовнішні АРІ – приклад результату відпрацювання методу
Рис. 2.9.1.13. Зовнішні АРІ – приклад скрипта
Далі після обробки відповіді методу в процес передаються змінні, значення яких за допомогою службової задачі BPMN можна встановити в якості атрибутів документа.
Рис. 2.9.1.14. Зовнішні АРІ – приклад встановлення атрибутів документа