Модули расширения системы > Пользовательские модули / Методы API в модулях

Методы API в модулях

Платформа предоставляет возможность автору модуля создать свои собственные методы для использования их в web API или в сценариях виджетов, страниц и процессов. Например, можно создать методы для запуска бизнес-процесса, сложной выборки данных или организовать методы для промежуточного взаимодействия с внутренней или внешней системой. Можно создавать функции общего назначения и использовать их повторно в разных местах.

Чтобы создать или отредактировать метод:

  1. Перейдите в Администрирование > Модули.
  2. Наведите курсор на модуль и нажмите на появившийся значок шестеренки.

extention-settings1

  1. Перейдите на вкладку Методы API.
  2. Нажмите Редактировать. Откроется редактор методов.
  3. Нажмите кнопку +Добавить. В открывшемся окне внесите нужную информацию.

exten_16

  • Название* — укажите название метода.
  • Адрес* —  Выберите метод для HTTP вызова: GET или POST. Укажите адрес, по которому будет доступен метод.
  • Функция* — создайте функцию, которая будет выполняться при получении запроса.
  • Авторизация — выберите тип авторизации, который будет применяться при получении запроса.
    • Внутренняя авторизация — метод можно будет вызывать из сценариев процессов, виджетов, форм, но при этом его нельзя будет вызвать из внешней системы. Пользователь, от имени которого исполняется сценарий, должен быть авторизован в ELMA365.
    • Внешняя авторизация — при выборе этой опции метод будет доступен из внешней системы по токену.
  • Асинхронный запуск — опция позволяет продолжить работу, не дожидаясь окончания выполнения метода.
  • Описание — укажите подробное описание метода.
  1. Перейдите на вкладку Сценарии и напишите метод. Для этого используется язык программирования TypeScript. Более подробно про принципы написания сценариев в ELMA365  вы можете прочитать в справке по TypeScript SDK .
  2. Сохраните и опубликуйте метод.

Доступ к глобальным константам

При написании методов можно использовать константу Global. Она дает доступ к переменным, содержащимся в разделах, и к глобальным параметрам. Использование этого объекта препятствует дальнейшей выгрузке модуля. То есть, если использовать константу Global для написания метода API, то этот модуль с этим методом нельзя будет экспортировать.

Чтобы разрешить доступ к константе Global:

  1. В редакторе методов, перейдите на вкладку Сценарии;

exten-17

  1. В верхнем меню нажмите Настройки;
  2. В открывшемся окне выберите опцию Global.

Нашли опечатку? Выделите текст, нажмите ctrl + enter и оповестите нас