Интеграция Comindware Platform с внешними системами. Общие рекомендации

Использование сервисов третьих сторон

Потенциальные риски и расходы, связанные с использованием сервисов третьих сторон

Использование сервисов третьих сторон в сочетании с Comindware Platform может быть сопряжено с рисками, перечисленными ниже (не ограничиваясь перечисленным). Кроме того, реализация таких рисков может повлечь непредвиденные сопутствующие расходы.

• Негативное влияние сервисов третьих сторон на работу Comindware Platform. См. «Сервисы, способные изменить работу приложений и процессов».
• Плата за потреблённые услуги, ресурсы, материалы, вызовы API и т. п. при подключении, использовании и адаптации стороннего ПО и сервисов.
• Недоступность стороннего ПО и сервисов со стороны их поставщиков.
• Ошибки данных, отображаемых на экране и (или) передаваемых в сервисы третьих сторон, а также в рамках ПО Comindware Platform.
• Невозможность бесшовной интеграции с учётом требований, особенностей учётных записей и передаваемых данных, а также сценариев использования ПО.
• Невозможность обеспечения анонимности и (или) конфиденциальности данных при их передаче между сторонним ПО и сервисами и Comindware Platform.
• Несоответствие результатов работы стороннего ПО и сервисов ожидаемым выводам, поведению ИТ-систем и поведению Comindware Platform.
• Невозможность использования результатов работы стороннего ПО и сервисов в качестве основы для принятия решений или действий.

Потенциальные риски и расходы, связанные с использованием данных и результатов работы сервисов третьих сторон

Использование данных и результатов, формируемых, обрабатываемых и возвращаемых сервисами третьих сторон в Comindware Platform, может быть сопряжено с рисками, перечисленными ниже (не ограничиваясь перечисленным). Кроме того, реализация таких рисков может повлечь непредвиденные сопутствующие расходы.

• Нарушение целостности данных при передаче между Comindware Platform и сервисами третьих сторон, а также при прохождении данных по цепочке через любые промежуточные системы.
• Компрометация безопасности данных вследствие утечек, несанкционированного доступа или нарушения протоколов безопасности при обмене данными со сервисами третьих сторон.
• Нарушение конфиденциальности данных при их передаче в сторонние сервисы и ПО, а также переносе результатов деятельности сервисов третьих сторон и ПО в Comindware Platform и далее по любым цепочкам любые системы.
• Трансграничная передача данных без обеспечения соответствия требованиям законодательства о защите персональных данных и иных нормативных актов, регулирующих трансграничную передачу информации в любых юрисдикциях.
• Потеря или искажение данных при преобразовании форматов, обработке или передаче данных между Comindware Platform и сервисами третьих сторон (в том числе через промежуточные системы).
• Недостаточность или неполнота данных, получаемых от сервисов третьих сторон, для корректной работы бизнес-процессов и принятия решений в Comindware Platform (равно как любых иных системах и процессах).
• Несоответствие форматов данных требованиям Comindware Platform или невозможность корректного преобразования данных из форматов, используемых сервисами третьих сторон или в такие форматы.
• Некорректность или недостоверность результатов работы сервисов третьих сторон, которые могут привести к ошибочным решениям или действиям в Comindware Platform (равно как любых иных системах и процессах).
• Невозможность восстановления данных в случае их утраты или повреждения при обмене с сервисами третьих сторон, промежуточными или иными системами.
• Нарушение требований к хранению и удалению данных вследствие особенностей работы сервисов третьих сторон, а также их политик хранения и обработки данных.

Сервисы, способные изменить работу приложений и процессов

К сервисам третьих сторон, которые могут повлиять на работу приложений и процессов, а также на данные в Comindware Platform относятся (не ограничиваясь перечисленным):

• сервисы искусственного интеллекта (ИИ) — системы машинного обучения, обработки естественного языка, генерации контента, анализа данных и принятия решений на основе ИИ;
• системы бизнес-аналитики (BI) — платформы для анализа данных, построения отчётов и дашбордов, визуализации данных;
• системы управления ресурсами предприятия (ERP) — 1С, SAP и т. п.;
• системы управления взаимоотношениями с клиентами (CRM) — Bitrix24, MS Dynamics и т. п.;
• сервисы электронного документооборота — СФЕРА Курьер, СберКорус и т. п.;
• сервисы облачного хранения данных — Yandex Cloud, VK Cloud AWS S3, Azure Blob Storage и т. п.;
• сервисы уведомлений и коммуникаций — MAX, Telegram, SMS-шлюзы, службы эл. почты и т. п.;
• сервисы интеграции и автоматизации — n8n, Zapier и т. п. платформы роботизации процессов;
• сервисы аналитики и мониторинга — OpenSearch, Elasticsearch, Zabbix и т. п.;
• иные сторонние системы — сервисы, интегрируемые с Comindware Platform через API, адаптеры, пути передачи данных или прочие механизмы интеграции.

Рекомендации по использованию сервисов третьих сторон

При интеграции и использовании сервисов третьих сторон рекомендуется:

• оценивать риски перед интеграцией: изучить документацию стороннего сервиса, его условия использования, политику конфиденциальности и ограничения;
• тестировать интеграции в изолированных средах разработки и тестирования перед развёртыванием в продуктивной среде;
• контролировать работу интегрированных сервисов и их влияние на производительность и стабильность приложений в Comindware Platform;
• обеспечивать резервное копирование данных перед интеграцией с сервисами, способными изменять данные и процессы;
• контролировать расходы на использование платных сервисов третьих сторон (вызовы API, хранилище данных, вычислительные ресурсы и т. п.);
• обеспечивать безопасность передаваемых данных и соответствие требованиям защиты персональных данных, конфиденциальной и проприетарной информации;
• иметь план отката на случай сбоев или недоступности сервисов третьих сторон.

Подробные сведения об ответственности и ограничениях использования сервисов третьих сторон см. в Лицензионном соглашении конечного пользователя ПО Comindware.

Возможности интеграций

Comindware Platform предоставляет гибкие инструменты для автоматизации обмена данными с внешними системами с перечисленными ниже возможностями.

Решение бизнес-задач

С помощью интеграций можно решить следующие задачи в бизнес-процессах:

• Обмен и синхронизация данных с популярными системами:
  • Электронная почта: автоматизация отправки и получения писем.
  • СФЕРА Курьер, СберКорус: автоматизация обмена данными с системой электронного документооборота.
  • СУБД: синхронизация данных с системами управления базами данных.
  • 1С: обмен финансовыми и управленческими данными.
  • Bitrix24: синхронизация с CRM-системой для управления клиентскими данными и бизнес-процессами.
  • Телфин, Novofon: автоматизация звонков, управления контактами и улучшение коммуникаций посредством системы IP-телефонии.
  • OnlinePBX: обмен данными с облачной АТС для управления звонками и контактами.
  • Megaplan: синхронизация с системой управления проектами для автоматизации задач и процессов.
  • Telegram: интеграция с чат-ботами, отправка уведомлений и сообщений.
  • SAP: обмен с ERP-системой данными о ресурсах и процессах предприятия.
  • DocuSign: автоматизация процесса подписания документов с помощью электронной подписи.
  • PBX: интеграция с телефонными системами для управления внутренними и внешними звонками.
  • MS Dynamics: синхронизация с CRM-системой Microsoft для управления клиентскими данными.
  • MailChimp, Unisender: автоматизация маркетинговых кампаний через интеграцию с сервисом рассылок.
  • UiPath: интеграция с платформой роботизации процессов для автоматизации рутинных задач.
• Импорт исторических данных: загрузка и синхронизация данных из старых систем для обеспечения их доступности и актуальности.
• Обмен данными с оборудованием и управление им: взаимодействие с различными устройствами и программно-аппаратными комплексами для автоматизации управления и мониторинга.

Гибкая настройка интеграций

Comindware Platform предоставляет набор гибких инструментов для реализации интеграций:

• Поддержка различных протоколов и форматов
  • Поддержка стандартных протоколов и форматов.
  • Использование методов RESTful API.
  • Передача данных в форматах JSON, XML и особых фирменных форматах.
  • Транзакционная обработка данных.
• Использование готовых решений и заказная разработка
  • Готовые модули для интеграции с популярными системами (1С, Telegram и др.).
  • Возможность разработки специализированных адаптеров.
• Гибкая настройка и управление интеграциями
  • Гибкая настройка сценариев обмена данными любой сложности.
  • Поддержка отправки, получения и двусторонней синхронизации данных.
  • Обмен данными по таймерам.
  • Настройка подключений и путей передачи данных.
  • Определение ролей систем и направлений интеграции.
• Автоматизация и оптимизация процессов
  • Минимизация ручного ввода данных.
  • Уменьшение количества ошибок за счёт автоматизации.
  • Распределение функциональной нагрузки между интегрируемыми системами.
  • Масштабирование бизнес-процессов.
• Интеграция оборудования
  • Использование в бизнес-процессах данных от специализированных устройств и аппаратуры.
  • Обмен данными с любыми техническими средствами и управление ими.

Передача произвольных данных

С помощью интеграций можно передавать любые данные, например:

• текстовые данные – информация в виде строк и сообщений;
• числовые данные – параметры и показатели в виде целых, десятичных, шестнадцатеричных чисел;
• дата, время и длительность – временные метки и интервалы;
• файлы – документы, изображения, цифровые подписи и файлы любых типов;
• двоичные данные – информация в специализированных бинарных форматах.

Роли Comindware Platform в интеграциях

Comindware Platform может как получать, так и отправлять данные, в том числе одновременно и асинхронно.

В зависимости от роли отличается процесс настройки Comindware Platform.

Получение запросов от внешних систем

Comindware Platform может получать данные в двух режимах:

• ожидание входящих запросов от внешних систем;
• отправка запроса во внешнюю систему и обработка ответа.

Для обмена данными с внешними системами может потребоваться преобразование форматов.

Получение данных посредством запроса во внешние системы можно осуществлять по таймеру.

Для доступа к API и внесения изменений в данные Comindware Platform внешняя система должна быть авторизована через аккаунт, которому предоставлены соответствующие права. См. «Системные роли. Определения, настройка, объединение, удаление».

Отправка запросов во внешние системы

Comindware Platform может отправлять запросы во внешние системы с помощью встроенных и заказных адаптеров:

• встроенные HTTP-адаптеры позволяют использовать методы PUT, POST, DELETE для изменения данных во внешних системах, а также метод GET для получения данных из них;
• заказные адаптеры позволяют передавать данные с использованием специализированных протоколов.

Для обмена данными с внешними системами может потребоваться преобразование форматов.

Двустороннюю синхронизацию данных можно осуществлять по таймеру с требуемым интервалом времени.

Для подключения к внешним системам экземпляр ПО Comindware Platform должен пройти авторизацию с соответствующими правами.

Доступные механизмы интеграции

Прежде чем приступать к настройке интеграции, ознакомьтесь с доступными механизмами и их особенностями:

Преимущества разных механизмов интеграции

Comindware Platform поддерживает несколько механизмов интеграции, каждый из которых решает специфические задачи.

Ниже представлены ключевые особенности и преимущества каждого механизма.

Встроенные адаптеры

Встроенные адаптеры представляют собой готовые решения для интеграции с популярными системами посредством HTTP-запросов, SMTP, IMAP и других стандартных протоколов.

Преимущества

• Быстрое подключение: минимум настроек — достаточно настроить подключение, аутентификацию и сопоставление данных.
• Поддержка специализированных процессов: помимо сценариев можно настроить обработку данных непосредственно в бизнес-процессе.
• Низкий порог входа: не требуются навыки программирования.

Пример: отправка и получение электронной почты.

OData

Интеграция по протоколу OData обеспечивает автоматическую двустороннюю синхронизацию данных между Comindware Platform и внешними системами.

Преимущества

• Автоматизация по расписанию: данные обновляются без ручного вмешательства.
• Не требуется настройка сценариев: достаточно настроить подключение, аутентификацию и параметры синхронизации.
• Полная синхронизация: поддерживается массовая выгрузка и загрузка записей.

Пример: массовый импорт/экспорт данных в 1С.

REST API Comindware Platform

Посредством API Comindware Platform внешние системы могут напрямую манипулировать данными в Comindware Platform.

Преимущества

• Стабильность: методы API обычно не меняются в пределах мажорной версии ПО, либо обеспечивается их обратная совместимость.
• Безопасность: API обеспечивает изоляцию внешних систем от Comindware Platform и предоставляет расширенные возможности для настройки аутентификации и авторизации.
• Стандартизация: API позволяет автоматизировать процессы обмена данными в стандартном формате JSON или XML.

Пример: создание задач в бизнес-процессах посредством POST-запросов.

Заказные адаптеры

Решение для интеграции с системами, использующими проприетарные протоколы или оборудование.

Преимущества

• Работа с нестандартными протоколами и оборудованием: можно реализовать взаимодействие по проприетарным протоколам и с аппаратным обеспечением.
• Нестандартная обработка данных: при настройке адаптера можно создать уникальную структуру обрабатываемых данных

Пример: вывод этикеток с QR-кодами на принтер.

Общий порядок настройки интеграции

Чтобы настроить интеграцию, выполните следующие шаги:

1. Определите роли систем:

   • какая система инициирует запросы, а какая — ожидает;
   • какая система является отправителем данных, а какая — получателем;

2. Определите структуру и формат передаваемых данных.

3. Настройте сопоставление данных между Comindware Platform и внешней системой:

   • В Comindware Platform настройте необходимые шаблоны и атрибуты.
   • Во внешней системе настройте требуемую модель данных, например таблицы и поля.

4. Настройте интеграцию в Comindware Platform:

   • Для OData

     • Настройте подключение типа «Подключения REST и OData» — «Синхронизация с веб-сервисом».
     • Настройте синхронизацию данных с OData-сервисом на странице «Интеграции» ‌ приложения.

     См. «Синхронизация с веб-сервисом. Интеграция по OData».

   • Для HTTP-запросов, эл. почты и других встроенных адаптеров

     • Настройте подключение к внешней системе.
     • Настройте путь передачи данных для сопоставления данных между Comindware Platform и внешней системой.
     • Настройте сценарий или бизнес-процесс для обработки и преобразования данных.

     См. «Подключения. Определения, типы, создание, настройка, удаление», Пути передачи данных, «Сценарии. Определение, создание, настройка, использование», «Диаграмма процесса. Определения, просмотр, редактирование, публикация».

   • Для заказных адаптеров

     • Создайте решение Visual Studio с исходным кодом адаптера.
     • Добавьте и скомпилируйте адаптер на странице «Адаптеры» ‌.
     • Настройте подключение посредством адаптера.
     • Настройте путь передачи данных для сопоставления данных между Comindware Platform и адаптером.
     • Настройте сценарий или бизнес-процесс для обработки и преобразования данных.

     См. «Адаптеры. Определения, настройка, удаление».

   • Для REST API Comindware Platform

     • Настройте в Comindware Platform аккаунт, который внешняя система будет использовать для доступа к API.
     • Настройте во внешней системе использование необходимых заголовков аутентификации.
     • Настройте во внешней системе вызов методов API Comindware Platform.

     См. «Введение в API».

Логика использования подключений и путей передачи данных

Для использования встроенного или заказного адаптера, например для обработки HTTP-запросов или эл. почты, в Comindware Platform необходимо настроить подключение к внешней системе и путь передачи данных.

• Подключение представляет собой канал передачи данных между Comindware Platform и внешней системой.
• Путь передачи данных представляет собой модель сопоставления данных с внешней системой. Для одного подключения можно настроить несколько путей передачи данных для реализации разной логики сопоставления и преобразования данных.

См. «Подключения. Определения, типы, создание, настройка, удаление», Пути передачи данных.

Доступ к API Comindware Platform

Comindware Platform предоставляет методы REST API, позволяющие манипулировать данными шаблонов записей, бизнес-процессов и других сущностей.

Чтобы посмотреть и протестировать доступные методы в интерфейсе Swagger, откройте следующий URL в браузере:

http://your-host/docs 

Здесь your-host — адрес сервера Comindware Platform.

Для доступа к интерфейсу Swagger требуется авторизация с соответствующими правами.

Подробные сведения см. в Справочнике по API.

Отладка HTTP-интеграций

Чтобы проверить корректную работу настроенной интеграции, воспользуйтесь одним из следующих инструментов:

• В командной строке отправьте запрос при помощи Curl и проверьте полученный ответ.
• Используйте сервисы для отладки HTTP-запросов, например:
  • Postman
  • Apidog
  • Insomnia
  • Hoppscotch
  • SoapUI

Примеры настроек интеграций

Для работы с электронной почтой

• Отправка эл. почты из сценариев по SMTP/Exchange
• Получение эл. почты с помощью сценариев через IMAP и Exchange
• Отправка почты из процесса
• Получение эл. почты и веб-запросов в процессе

Для работы с HTTP-запросами

• HTTP-запросы типа GET. Отправка запроса и обработка ответа в формате JSON
• HTTP-запросы. Получение JSON-данных в сценарии
• HTTP-запросы. Получение и обработка данных с помощью JSONPath
• HTTP-запросы типа POST. Отправка и получение ответа
• HTTP-запросы типа POST. Отправка составного содержимого и файлов
• HTTP-запросы с составным содержимым. Получение файлов в сценарии

Для работы с СУБД

• Внешняя СУБД (MySQL, MSSQL, Oracle, PostgreSQL). Отправка SQL-запроса. Настройка подключения, пути передачи данных и сценария
• Внешняя СУБД (MySQL, MSSQL, Oracle, PostgreSQL). Получение данных по таймеру. Настройка подключения, пути передачи данных и сценария

Для работы с различными сервисами

• Синхронизация с веб-сервисом. Интеграция по OData
• Интеграция с 1С по OData. Настройка для импорта данных
• Collabora Online. Настройка подключения
• Р7 Офис. Настройка сервера и подключения
• Отправка запросов данных в «СФЕРА Курьер»
• Получение документов из «СФЕРА Курьер»
• Отправка уведомлений с помощью Telegram-бота

Типичные проблемы и их решения

В процессе настройки и использования интеграции могут возникнуть различные ошибки.

Ниже приведены типичные проблемы и возможные способы их устранения:

• Некорректно настроено подключение к внешней системе
  • Проверьте параметры соединения, например адрес сервера и учётные данные, указанные в свойствах подключения.
  • Проверьте соединение в свойствах подключения.
• Отключено подключение или путь передачи данных
  • Проверьте, не установлен ли флажок «Отключить» в свойствах подключения и пути передачи данных.
• Неправильно настроены атрибуты сообщений или параметры интеграции
  • Сверьте настройки пути передачи данных с документацией внешней системы.
  • Проверьте работу интеграции по журналам работы адаптеров.
• Неправильно названы, структурированы или сопоставлены поля данных
  • Убедитесь, что системные имена и структура атрибутов сообщений в свойствах пути передачи данных соответствует модели данных во внешней системе.
  • Убедитесь в соответствии типов данных в Comindware Platform и внешней системе.
  • При необходимости добавьте преобразование типов.
• Неверно задан формат данных
  • Убедитесь, что Comindware Platform и внешняя система передают данные в одном формате (JSON, XML и т. д.).
  • При необходимости добавьте необходимые действия для преобразование данных, например с помощью сценария.
• Проблемы с правами доступа
  • Предоставьте необходимые права аккаунту, который внешняя система использует для доступа к API Comindware Platform.
• Ошибки аутентификации
  • Проверьте корректность учетных данных в свойствах подключения Comindware Platform к внешней системы.
  • Убедитесь, что корректно настроена аутентификация Comindware Platform для доступа к API внешней системы.
  • Убедитесь, что используются актуальные токены доступа.
• Отсутствуют данные в ответе на запрос
  • Проверьте, корректно ли формируется запрос.
  • Убедитесь, что все обязательные поля заполнены.
  • Протестируйте запрос с помощью инструментов отладки.
• Ошибки в сценарии или процессе для обмена данными
  • Удостоверьтесь, что используются корректные структуры данных.
  • Добавьте действия для проверки входящих и исходящих данных.
  • Найдите ошибки с помощью инструментов отладки.