跳至主要內容

连接器资源

连接器资源

简介

连接器实质为一种功能强大的预构建 API 集成。在连接器资源中，您可以管理当前的连接器以及创建新的自定义连接器。在连接器资源中可以创建并定义新的连接器使其与第三方应用系统相关联，并在此界面进行统一管理。

image-20240708104829416
image-20240708104829416

新增连接器

在连接器界面，您可以方便地新增连接器。

  1. 首先，点击"新建连接器"按钮，会弹出设置"连接器名称"的窗口。在设定好名称后，点击“确定”您将被引导至连接器配置页面；

注意

连接器名称不可重复

1
1
  1. 在连接器配置页面，您需依次设置连接器的基本信息、安全认证、定义动作、测试等信息；
  2. 在基本信息中，您需要对连接器的名称，所属企业，所属产品以及版本等相关信息进行设置；
  • 连接器名称- 展示名称为设置定好的连接器名称，可以进行编辑修改
  • 连接器所属企业- 可设置连接器所属企业，填写后会展示在连接器基础信息中。非必填
  • 连接器所属产品- 可设置连接器所属产品，填写后会展示在连接器基础信息中。非必填
  • 版本号- 设置连接器版本号。必填
  • 描述- 可设置连接器描述，填写后会展示在连接器的基础信息中。非必填
  • 连接器图标- 可选择内置图标，也可自定义上传图标，图标会展示在连接器卡片中
  • baseurl- 设置需进行连接的第三方系统的根域名。必填
  • QPS- 设置每秒查询率秒查询率。必填
7
7
  1. 在“基本信息”中点击“下一步”，即会进入“安全认证”界面中。在此界面，您需设置创建连接时的安全认证，可选两种，分别为无身份验证，API密钥；

  • 无身份验证- 即当创建连接时，无身份验证设置，直接即可创建连接

  • API密钥- 即当创建连接时需进行API密钥验证才可进行创建连接。当使用API密钥验证时，需设置密钥参数信息和获取密钥信息属性

  • 参数名称- 输入密钥参数的名称

  • 参数位置- 选择参数位置，下拉框进行选择，可选有Heared，Query，Body

  • 认证地址- 输入认证地址的相对路径

  • 请求地址- 选择请求方式，可选有GET，POST

  • 超时时间- 设置响应超时的时间，时间范围为1-1800秒

  • 密钥失效时间- 设置密钥失效的时间，可选时间范围为30-120分钟

  • 密钥请求参数- 在此设置请求参数，对请求参数的参数名，参数展示名，参数位置，默认值等信息

  • 响应参数- 将示例导入后，点击右侧按钮进行解析，即可在下方选择相关的响应的参数

8
8
  1. 在"定义动作"，可以设置连接器的可执行操作。点击"新增动作"进入到动作配置界面；
image-20240708160824747
image-20240708160824747

在新增动作界面内配置动作的基本信息以及动作参数；

  • 动作名- 动作的名称

注意

名称只能包含字母、数字、中划线、下划线，并且只能以小写字母开头，长度不超过25个字符

  • 动作展示名- 动作的展示名称

注意

动作展示名长度不可超过16个字符

  • 动作展示分组- 可直接输入动作展示分组名称，输入后下拉框中新增对应的动作展示分组
  • 动作描述- 输入动作的描述信息
  • 动作参数- 点击左下角“新增动作参数”，即可新增一条动作参数列表，设置动作参数的参数名、参数展示名、参数展示分组、参数类型、必填、默认值、参数描述信息
image-20240708164720106
image-20240708164720106

点击下一步后，即会进入到“后端配置”页面中

  • 后端域名- 即在“基本信息”页面的baseurl，不可编辑
  • 后端路径- 连接器动作的后端访问路径
  • 请求方法- 调用API接口的请求方法
  • 后端超时- 设置后端访问的超时时间
  • 请求参数- 在基本信息增加的动作参数，会展示在后端配置请求参数列表中。在此你可以重新编辑后端参数名，以及选择后端参数位置
  • 常量参数- 可设置常量参数，常量参数的值取自于列表中参数值
  • 返回示例- 可设置动作运行后的返回示例
image-20240708172913854
image-20240708172913854
  1. 在测试界面支持对当前的连接器所设置的动作进行测试，并在右侧展示测试结果；
  • 初始化配置- 当使用api密钥验证时，需先进行授权配置才可进行进一步的测试操作
  • 参数- 设置连接器动作的参数信息
  • 测试结果- 当初始化配置和参数都设置完成后，即可点击“测试”按钮，查看动作执行结果
image-20240708174942578
image-20240708174942578
  1. 在此界面，可以选择发布或保存操作，发布成功即可进行创建连接。
image-20240708175718849
image-20240708175718849

连接器管理

在连接器资源页面中，您可以复制并新增连接器，或者删除连接器。此外，还可以查看连接器详情和进行编辑操作。

  • 创建连接

可将当前连接器与目标第三方系统创建连接；点击“创建连接”后进入到新增连接界面，即可配置连接项后创建连接。

注意

连接器需先发布才可创建连接

2
2
  • 复制并新增连接器

可创建新的连接器并将当前连接器所有参数克隆至新连接器中；点击“复制并新增连接器”选项后在窗口中设置连接器名称以及版本号属性，即可复制并新增一个新连接器。

3
3
  • 删除

可对连接器进行删除操作。

注意

若连接器未创建连接，则可直接删除；若连接器已创建连接，则无法直接删除，需取消连接后删除

4
4
  • 查看详情

在卡片式连接器界面中直接点击连接器卡片即可进入连接器详情。

5
5

在连接器详情部分，您可以查览关于连接器的基本信息、认证信息以及动作信息。这些信息与连接器配置中的内容一致。

  • 编辑- 点击“编辑”按钮，进入到编辑界面中，可对连接器配置进行修改
  • 创建连接- 点击“创建连接”按钮，进入到创建连接界面中进行创建连接操作
6
6