Перейти к основному содержимому

Настройка BPMN-элемента REST Outbound Connector

После добавления BPMN-элемента на схему бизнес-процесса вам нужно настроить параметры этого BPMN-элемента.

Чтобы настроить параметры BPMN-элемента REST Outbound Connector:

  1. На BPMN-схеме выберите элемент REST Outbound Connector.

  2. На панели справа укажите следующие параметры BPMN-элемента:

    • Task definition type (обязательный параметр): введите io.camunda:http-json:1.

    • AuthenticationType : из раскрывающегося списка выберите способ авторизации для этого BPMN-элемента:

      • None: авторизация не требуется. Этот вариант выбран по умолчанию.

      • Basic: авторизация на основе секретов. Создайте секрет и укажите следующие дополнительные параметры:

        • Username: имя пользователя, например, {{secrets.YOUR_USERNAME}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • Password: укажите пароль к созданному секрету, например, {{secrets.REST_BASIC_SECRET}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
      • API key: авторизация с помощью ключа API. Укажите следующие дополнительные параметры:

        • API key location: укажите расположение ключа API:
          • Headers: ключ API будет добавлен в заголовок запроса;
          • Query parameters: ключ API будет добавлен в URL в виде строки запроса.
        • API key name (обязательный параметр): введите имя параметра, ожидаемое API, например, apiKey. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • API key value (обязательный параметр): укажите ссылку на секрет, который вы создали для ключа API, например, {{secrets.REST_API_KEY_SECRET}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
      • Bearier Token: авторизация с помощью токена на предъявителя. Введите значение обязательного параметра Bearier TokenBearier Token, например, {{secrets.REST_BEARER_TOKEN}}.

      • OAuth 2.0: авторизация с использованием протокола OAuth 2.0. Создайте секрет и присвойте ему имя, например, OAUTH_TOKEN_ENDPOINT, чтобы ссылаться на секрет в этом BPMN-элементе.

        • OAuth token endpoint (обязательный параметр): укажите конечную точку токена OAuth, например, {{secrets.OAUTH_TOKEN_ENDPOINT}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • Client id (обязательный параметр): укажите идентификатор клиента для созданного секрета, например, {{secrets.CLIENT_ID}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • Client secret (обязательный параметр): укажите секрет клиента для созданного секрета, например, {{secrets.CLIENT_SECRET}}. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • Audience (необязательный параметр): введите уникальный идентификатор целевого API, к которому нужно обратиться. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
        • Client authentication (обязательный параметр): выберите способ авторизации клиента:
          • Send client credentials in body: в теле запроса отправить идентификатор клиента и секрет клиента в качестве учетных данных клиента.
          • Send as Basic Auth header: в заголовке запроса отправить идентификатор клиента и секрет клиента в качестве основного запроса на аутентификацию.
        • Scopes (необязательный параметр): использование этого параметра зависит от OAuth-поставщика. Укажите области разрешений доступа, которые вы хотите использовать в запросе, например, read:clients. Вы можете использовать выражение на языке FEEL для описания значения этого параметра.
    • HTTP EndpointMethod (необязательный параметр): из списка выберите метод HTTP-запроса. В списке отображаются GET, DELETE, POST, PATCH, PUT.

    • HTTP EndpointURL (обязательный параметр): введите URL-адрес REST API, к которому нужно обратиться.

    • HTTP EndpointHeaders (обязательный параметр): введите выражение на языке FEELS для описания HTTP-заголовка запроса. Например, введите следующее выражение:

    = {
    Origin: "https://modeler.camunda.io/"
    }
    • HTTP EndpointQuery params (обязательный параметр): введите выражение на языке FEELS для описания параметров запроса. Например, введите следующее выражение:
    = {
    q: "Berlin",
    appid: "{{secrets.OPEN_WEATHER_MAP_API_KEY}}",
    units: "metric",
    lang:"en"
    }
    • Connection timeoutConnection timeout in seconds (обязательный параметр): введите время ожидания (в секундах) соединения с сервером или введите 0 для бесконечного времени ожидания.

    • Output mappingResult variable (обязательный параметр): введите имя переменной для записи результата.

    • Output mappingResult expression (обязательный параметр): введите переменную для записи результата выполнения запроса.

    • Error handlingError expression (обязательный параметр): введите выражение на языке FEEL для описания условия обработки ошибок выполнения REST-запроса и управления поведением бизнес-процесса. В выражении используйте коды ошибок сервиса BPMS Платформы. Например, введите следующее выражение:

        if error.type= "404"  then bpmnError("er1", error.message) else  null
    • RetriesRetries (необязательный параметр): введите количество попыток выполнения REST-запроса, например, 1.

    • RetriesRetry backoff (необязательный параметр): введите время задержки (в секундах) между попытками выполнения REST-запроса.

  3. Вверху справа нажмите Сохранить.