Веб-обработчик

Для создания обработчика:

  1. В ЦН перейдите в раздел Интеграция → Обработчики.

  2. Нажмите на кнопку +. В рабочей области страницы отобразится интерфейс создания нового обработчика.

  3. На вкладке Основные в выпадающем меню Тип выберите вариант Веб-обработчик:

../../../_images/web_handler.png

  1. На вкладке Основные произведите следующие настройки:

  • Поле Название: введите название обработчика, обязательно для заполнения.

  • Поле Имя: введите имя обработчика, необязательно для заполнения.

  • Поле Комментарий: введите описание обработчика, необязательно для заполнения.

  • Выпадающее меню Тип: в данном случае выбран вариант Веб-обработчик.

  • Поле Имя таблицы: введите имя таблицы обработчика.

  • Выпадающее меню Внешний тип данных: выберите тип внешнего типа данных.

  • Поле Шаблон пути: введите шаблон пути для обработчика. В поле могут быть использованы следующие параметры:

    • {path} - путь к методу со всей иерархией папок

    • {method} - имя метода

    • {folder} - имя текущей папки метода

  • Выпадающее меню Тип метода: выберите один из типов метода:

    • Get

    • Post

    • Put

    • Delete

    • Patch

  • Поле Таймаут вызова: введите значение таймаута вызова обработчика, значение по умолчанию - 10000.

  • Флажок Ожидание ответа: установите флажок, если ожидается получение ответных сообщений.

  • Меню Ограничение скорости обработки входящих запросов: выберите вариант ограничения скорости обработки входящих запросов (подробная инструкция приведена в разделе Расширенное REST API).

  1. После внесения данных нажмите на кнопку Сохранить изменения.

На вкладке Параметры добавляются параметры обработчика:

../../../_images/web_handler_params.png

В поле Полный путь указывается путь к используемому типу данных. Например, ContentType.

В поле Значение можно добавить формат и кодировку заголовков сообщений.

Например: text/plain; charset=utf-8

Поддерживаются следующие кодировки:

  • UTF-8

  • UTF-16

  • UTF-32

  • ASCII

  • Unicode (может заменяться на UTF-16)

Остальные кодировки по умолчанию заменяются на UTF-8, при этом будет создано соответствующее предупреждение в журнале.

Формат и кодировка заголовков также могут быть настроены в коде обработчика.

В поле Тип может быть указано максимальное количество символов в заголовке. Например, String[500].

Флажок Обязательно используется для обязательной передачи параметра в запросе. В шаблоне пути обработчика могут быть указаны только обязательные параметры. Если запрос отправлен без обязательного параметра, указанного в шаблоне пути, отправка завершается ошибкой 400. В шаблоне пути обязательный параметр указывается по имени (name), если оно задано. Параметры обработчика (обязательные и необязательные) могут быть указаны в запросе в виде Query String. Если параметр указан в адресе URL, используется алиас параметра, при отсутствии алиаса используется имя параметра.

Обязательные параметры, указанные в адресе URL, выделяются «звездочкой» в сваггере внешней системы:

../../../_images/required_swagger.png

На вкладке Код вносится код обработчика на языке C#.

В коде обработчика c направлением В Platform доступна переменная RunMessage. В этой переменной содержится сообщение, полученное из внешней системы. Содержимое переменной RunMessage можно модифицировать с помощью методов для работы с сообщениями. После завершения работы обработчика содержимое переменной RunMessage отправляется в Платформу. Например, RunMessage.SetBody(Object); - установить новое тело сообщения.

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

Пример кода с составным значением:

ContentType =  String.Format("application/soap+xml; charset=utf-8;");

Для выполнения обработчика на системе необходимо присвоить обработчик системе. Для этого на вкладке Системы добавьте в список Системы обработчика обработчик из списка Доступные системы путем выбора строчки и нажатием на кнопку >. Обработчик может выполнятся на нескольких системах:

../../../_images/web_handler_sys.png