Типы каналов интеграции

Путь расположения

Путь в сборочном каталоге

/era_env/priv/sys_metadata/solutions/<SOLUTION>/webservices.json

Обзор

Дескриптор специфических типов каналов интеграции – точек доступа к внешним сервисам. Формирует типы доступных интеграционных точек для доменов текущего солюшена, определяет для каждого из них используемые сценарии-адаптеры протокола.

Доступно также для мастер-домена (предопределенный солюшен master).

Формат:
[
  {
    "type": str,
    "recv_svcscriptcode": str,
    "recv_svcscriptcode_ws": str,
    "recv_timeout": int,
    "send_svcscriptcode": str,
    "send_svcscriptcode_ws": str,
    "url": "https://...",
    "issync": true | false
  },
  ...
]
  • type – произвольное название типа.

  • recv_svcscriptcode – код службеного сценария-адаптера, обрабатывающего полученные в виде HTTP-хуков http-сообщения от внешней системы или веб-сервиса.

  • send_svcscriptcode – код служебного сценария-адаптера, обрабатывающего отправляемое к внешней системе или веб-сервису сообщение.

  • recv_svcscriptcode_ws – (опционально) код службеного сценария-адаптера, обрабатывающего полученные в виде сообщений через websocket-подключения от внешней системы или веб-сервиса.

  • send_svcscriptcode_ws – (опционально) код служебного сценария-адаптера, обрабатывающего отправляемое к внешней системе или веб-сервису сообщение через существующее websocket-соединение.

  • url – url точки подключения к веб-сервису или его адаптеру.

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

  • recv_timeout – максимальное время исполнения сценария recv_svcscript в секундах. Значение по-умолчанию (0) означает, что будет применено значение, определённое веб-сервером (10 сек.). Максимально позволенное значение - 60 сек.

Создаваемые со специфическими типами сущности точек интеграции не имеют возможности изменять упомянутые в метаданных параметры: сценарии, url, и др.

Содержание сценариев при подобной настройке формируется отдельно и располагается среди ассетов.

Пример

Определяет три типа точек интеграции, под каждую определяет адрес и скрытые сценарии.

Пример:
[
  {
    "type": "telegram",
    "recv_svcscriptcode": "webservice_telegram_recv",
    "send_svcscriptcode": "webservice_telegram_send",
    "url": "https://149.154.167.40:443/",
    "issync": false
  },
  {
    "type": "vk",
    "recv_svcscriptcode": "webservice_vk_recv",
    "send_svcscriptcode": "webservice_vk_send",
    "url": "http://127.0.0.1:12345/api/vk/v1/webservice?mode=sync",
    "issync": true
  },
  {
    "type": "subscr",
    "recv_svcscriptcode": "webservice_subscr_recv",
    "recv_svcscriptcode_ws": "webservice_subscr_recv",
    "send_svcscriptcode": "webservice_subscr_send",
    "url": "http://127.0.0.1:12345/api/subscr/v1/webservice?mode=sync",
    "issync": true
  }
]