更新时间:2025-07-04 GMT+08:00
分享

HTTP请求

HTTP请求连接器可以通过HTTP/HTTPS协议调用其它开放的API,以获取编排所需的数据。

创建HTTP请求连接

  1. 登录新版ROMA Connect控制台
  2. 在左侧导航栏选择“连接器”,在连接器页面单击“新建连接”。
  3. 选择“HTTP请求”连接器。
  4. 在弹窗中配置连接器信息,完成后单击“确定”。

    参数

    说明

    连接名称

    填写连接器实例名称。

    基本地址

    为所有请求设置基本地址,基本地址格式:http://example.com/v1 或 https://example.com/v1

    安全认证

    要调用API所使用的认证方式。

    • APP认证:使用API所授权集成应用的Key和Secret进行API请求的安全认证。
    • 无认证:表示API请求不需要认证。
    • Client Credentials认证:通过Client ID和Client Secret来获取Access Token,并使用该Token进行 API 请求的认证。
    • Basic Auth认证:通过将用户名和密码进行 Base64 编码后放入 HTTP 请求头中进行认证;适用于对安全性要求不高的内部系统或测试环境。
    • Secret认证:通过预共享密钥进行 API 请求认证的方式。

    APP Key

    仅当“安全认证”选择“APP认证”时需要配置

    API所授权集成应用的Key。

    APP Secret

    当“安全认证”选择“APP认证”时需要配置

    API所授权集成应用的Secret。

    AccessTokenUrl

    仅当“安全认证”选择“Client Credentials认证”时需要配置

    获取访问令牌的地址(由 API 提供方提供)。

    ClientId

    仅当“安全认证”选择“Client Credentials认证”时需要配置

    API 提供方分配的客户端 ID。

    ClientSecret

    仅当“安全认证”选择“Client Credentials认证”时需要配置

    API 提供方分配的客户端 ID。

    scope

    仅当“安全认证”选择“Client Credentials认证”时需要配置

    API 访问权限范围,根据 API 提供方的要求填写。

    用户名

    仅当“安全认证”选择“Basic Auth认证”时需要配置

    API 认证的用户名。

    密码

    仅当“安全认证”选择“Basic Auth认证”时需要配置

    API 认证的密码。

    Secret

    仅当“安全认证”选择“Secret认证”时需要配置

    API 提供方分配的密钥。

    描述

    填写连接器的描述信息,用于识别不同的连接器。

支持的动作

  • GET:GET 请求用于从服务器获取资源。它将请求参数附加在 URL 中,适用于查询数据或获取资源的场景。
  • POST:POST 请求用于向服务器提交数据,通常用于创建新资源或执行操作。
  • PUT:PUT 请求用于更新服务器上的资源,适用于替换或更新整个资源的场景。
  • DELETE:DELETE 请求用于删除服务器上的资源。
  • HEAD:HEAD 请求与 GET 请求类似,但服务器只返回响应头,不返回响应体。它通常用于获取资源的元数据(如文件大小、修改时间等)。
  • OPTIONS :OPTIONS 请求用于获取目标资源所支持的通信选项。
  • PATCH:PATCH 请求用于对服务器上的资源进行部分更新。
  • TRACE:TRACE 请求用于回显服务器收到的请求,用于诊断和测试。

配置参数

表1 请求配置参数

参数

说明

请求地址

请求地址为绝对地址或相对地址(如果在连接器中设置了基本地址)。绝对地址格式为http://example.com/v1 或 https://example.com/v1,相对地址格式为:/v1。

失败时停止

请求失败时,是否停止业务流任务并报错。

参数

配置请求参数。单击“添加”,以键值对的形式添加请求参数。参数包括以下三种类型:

  • Query:附加在 URL 末尾,用于向服务器传递额外的信息。
  • Header:包含在 HTTP 请求头中,用于传递与请求相关的元数据或认证信息。
  • Path:直接嵌入在 URL 路径中的变量,用于指定资源的唯一标识或层级结构。在请求地址中设置格式为{Path}的路径,将自动添加Path类型的参数。

请求体类型

仅当HTTP请求的动作选择“POST”、“PUT”或“PATCH ”时需要配置

选择API的请求Body体类型,包括raw/form-data/x-www-form-urlencoded三种类型。

请求体

仅当HTTP请求的动作选择“POST”、“PUT”或“PATCH ”时需要配置

填写API的请求Body体内容。

响应头数据结构

返回json格式响应头数据。键表示Header字段名称,值表示Header字段值。每行数据以逗号拼接。Payload说明详见引用变量

响应体数据结构

返回json格式响应体数据。键表示Body字段名称,值表示Body字段值。每行数据以逗号拼接。Payload说明详见引用变量

相关文档