Execute API call#


../../_images/execute-api-call.png

Основные сведения#

Шаг “Execute API Call” используется для взаимодействия с внешними системами через API. Этот шаг может быть настроен для различных типов запросов, включая получение данных (GET), отправку данных (POST/PUT), или удаление данных (DELETE) во внешней системе. В зависимости от контекста использования, этот шаг может быть одним из первых в Dataflow для получения данных или одним из последних для обновления данных во внешних системах.

Параметры#

Настройки Шага:

Поле настройки

Варианты значений

Назначение

Step name

-

Наименование шага

Source step

-

Выбор предыдущего шага

Result store field

-

Поле для хранения идентификатора созданной или обработанной записи

System

-

Выбор интеграционной системы

Connector

-

Выбор коннектора в интеграционной системе

Query path

-

EndPoint для запроса

Method name

Get, Post, Put, Delete

Тип запроса для выполнения

Parameters mapping

-

Динамическая настройка для фильтрации запроса

Кейсы#

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

  • Отправка или обновление данных: Подходит для отправки данных во внешние системы или обновления существующих данных, например, при синхронизации изменений, произведенных в рамках dataflow.

  • Удаление данных: Может использоваться для удаления данных из внешних систем, что помогает поддерживать актуальность и целостность данных в интегрированных системах.

Исключения#

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

  • Требование к настройке коннекторов: Эффективность шага зависит от корректно настроенных интеграционных систем и коннекторов, а также от точности определения EndPoint и параметров запроса.

Вариант применения#

Компонент создает простую интеграцию для получения данных, таких как погода, через API. В датафлоу используются шаги для настройки запроса к API, включая выполнение скрипта для создания переменных API, вызов API и сохранение результатов. Затем интеграция выбирается и настраивается в системе, а результаты отображаются на фронте с помощью формы, связанной с выполнением скрипта. Функция в компоненте обрабатывает полученные данные для отображения пользователю.

  • Вы можете скачать конфигурацию компонента здесь