创建应用程序连接器

本文包含以下主题：

应用程序连接器

“新建应用程序连接器”按钮可帮助您创建和管理您的应用程序连接器。应用程序连接器同时支持基于云的应用程序和内部部署应用程序。每个连接器执行各种不同的操作。 “操作”描述了由远程系统提供的 HTTP、REST API 的列表。每个操作都由 URL 端点、输入和输出参数来确定。这些操作可用于过程或工作流。在自动化工作流和添加连接器以执行操作的过程中，您需要设置连接器凭据。在“凭据”选项卡中，您可以定义每个连接器连接到外部系统时所需的凭据。有关如何设置连接器凭据的详细信息，请参阅“连接器凭据”。

通过单击“工作区”、“自动化”、“自动化中心”、“连接器库”、“新建应用程序连接器”，您可以导航到该选项卡。

创建应用程序连接器的过程包括以下步骤：

了解要为其构建应用程序连接器的目标应用程序的 API。
定义应用程序连接器
配置身份验证参数并验证
设置一个或多个连接器操作
在工作流中使用应用程序连接器

在以下主题中将进一步说明这些步骤。

了解要为其构建应用程序连接器的目标应用程序的 API。

定义应用程序连接器的第一步是了解您要为其构建应用程序连接器的目标应用程序的 API。需要以下信息：

API URL - 目标应用程序的 URL。
身份验证类型 - 支持的身份验证类型有“基本”、“无”、和“高级”。
操作 - “操作”描述了远程应用程序上的 API 调用的列表。每个操作都由 URL 端点、输入和输出参数来确定。

定义应用程序连接器

设置应用程序连接器的基本属性。
请执行以下步骤：

依次导航到“工作区”、“自动化”、“自动化中心”、“连接器库”。
单击“新建应用程序连接器”。
在“基本属性”部分中提供有关连接器的基本详细信息。基本详细信息包括：
- 应用程序连接器名称。
- API 版本。应用程序连接器是为由目标应用程序发布的特定 API 版本构建的。不同 API 版本之间的输入/输出参数、操作可能会有所变更。如果您有相同应用程序的不同版本的多个连接器，您可以使用此字段。
- 连接器说明介绍了连接器的用途。
- 连接器类型。可通过云或内部部署两种方式使用您的连接器。
- 连接器的基本 URL。 ServiceAide Cloud Service Management 使用此 URL 来连接服务。选择要用于连接器的用户身份验证类型。 ServiceAide Cloud Service Management 支持基本和高级身份验证。
- API 格式。 ReST API 请求/响应格式（内容类型）可以是 JSON 或 XML。
设置连接器操作。
单击“保存”。

配置身份验证参数并验证

ServiceAide Cloud Service Management 支持无、基本和高级身份验证。每个 HTTP rest 调用都需要身份验证。填写基本属性后，您可以为您的连接器配置身份验证参数。

基本身份验证：HTTP 支持的一种简单的身份验证技术。 “基本身份验证”需要用户名和密码。
无：“无”不需要身份验证。
高级身份验证：“高级身份验证”用于具有基于令牌的会话管理的应用程序。在此模型中，最终用户通过登录应用程序首次获取会话令牌，然后使用该会话令牌访问该应用程序中的其他资源。请务必在身份验证和后续操作中使用相同的安全令牌参数，以确保两者均在同一会话中。您可以查看 Rally 连接器以了解如何指定高级身份验证。

- 设置身份验证参数不会创建凭据。可以在“连接器库”选项卡或“设计工作室”中添加凭据。验证身份验证参数时会创建第一个验证信息。在定义期间，您可以将第一个验证信息用于所有后续操作。此外可以在工作流执行过程中使用该验证信息。

- 保存连接器后，将无法更改其身份验证类型。

请执行以下步骤：

依次导航到“工作区”、“自动化”、“自动化中心”、“连接器库”。
单击“新建应用程序连接器”
选择要用于连接器的用户身份验证类型。
单击链接“查看测试输出并选择参数”。
此时将显示一个弹出窗口，其中包含 JSON/XML 格式的身份验证调用响应。
从响应输出选择将参数传递给下一操作调用的令牌。单击“选择参数”。
解析字符串会自动作为输出参数显示在“输出参数”选项卡中的文本框中。
选择连接器从身份验证调用传递给下一个操作调用的参数。
注意：您可以在“命名标识”框中为该参数提供用户易记的名称，以便用于后续操作调用。
单击“保存”。
（可选）单击“验证”。
如果是基本身份验证，且用户名和密码输入正确，将自动验证。
如果是高级身份验证，将显示包含 JSON/XML 响应输出的弹出窗口。将显示“接受”和“拒绝”按钮。单击“接受”，状态将更改为“已验证”
（可选）如果高级身份验证也需要基本身份验证，请单击“使用基本身份验证”。
（可选）如果高级身份验证需要发送 cookie，请单击“发送 Cookie”。

设置一个或多个连接器操作

定义您的连接器可以执行的操作。 “操作”描述了远程应用程序上 API 调用的列表。每个操作都由 URL 端点、输入和输出参数来确定。这些操作可用于过程或工作流。

请执行以下步骤：

依次导航到“工作区”、“自动化”、“自动化中心”、“连接器库”、“新建应用程序连接器”。
单击“新建操作”。
左窗格中便添加了新的操作。在右窗格中，您可以定义操作的属性。会为该操作自动分配默认名称。您可以在“操作名称”字段中编辑此名称。
在“说明”字段中提供该操作的说明。
提供操作的子 URL。每个 ReST API 都使用唯一的 URI 进行标识。此 URI 被捕获为子 URL。示例： /ReST/v1_1/templates
选择该操作调用的 HTTP 方法。示例：GET、POST、PUT 和 DELETE。
单击“下一步”。
定义操作的输入参数和输出参数。
1. 输入参数：提供 API 所需的键。提供 URL 查询参数和 HTTP 头字段的值。选择 HTTP 正文数据的处理方式。在“正文”下拉列表中，选择“表单数据”或“原始数据”。
  每个 URL 参数都有三个字段。前两个字段捕获 URL 参数的键值对，第三个字段用于提供用户可读的键名。此字段显示在服务请求中时，将使用此值。单击 + 以添加更多参数。
  - 选择“表单数据”，然后在键值负载表单中输入“键”、“值”和“用户可识别名称”。
  - 选择“原始数据”，然后输入 JSON/XML 负载信息。
  - 在“值”文本框中提供 API 的所有测试值。在“用户识别名”中的值将创建连接器的输入参数。输入参数将显示在“数据映射”中。在“URL 参数”或“标题”文本框中提供实际的 URL 参数或标题键。
  - 要自定义子 URL 或负载的内容，并创建工作流创建时提供的输入参数值，请使用格式 {{VARIABLE_NAME:VALUE}}
2. 输出参数：提供操作输出的键和值。
  - - 单击“查看测试输出并选择参数”XML/JSON。您会收到树格式的响应。您可以展开树并选择一个值来使用该响应创建输出参数。
    - 每个输出参数都具有一个命名标识，这可以是用户为该连接器操作定义的名称。如果您需要发送步骤输出，您可以在工作流中使用该用户定义名称作为其他步骤的输入。
此时，单击“保存”仅会保存操作的详细信息。要保存新连接器，请单击页面顶部的“保存”。单击“下一步”以移至下一选项卡。单击“重置”可清除所有详细信息。
根据需要添加更多操作。
单击页面顶部的“保存”。

注意：在保存之前验证操作。单击“验证”，即可显示包含输出响应以及“接受”和“拒绝”按钮的弹出窗口。单击“接受”，状态将更改为“已验证”

您的应用程序连接器即被保存并添加到“连接器库”的“可用”选项卡中的连接器列表。现在可以使用此连接器并创建工作流，有关详细信息，请参阅“如何创建工作流”。现在，设计的工作流可以链接到过程设计器中的过程流程，请参阅“使用自动化步骤”了解详细信息。

使用自动化工作流中的应用程序连接器

在过程设计器中创建过程流程的同时，可以使用应用程序连接器自动执行作为自动化工作流创建的一部分的任务。

使用自动化工作流中的应用程序连接器的示例（特别重复性使用）

IT 支持人员收到修理笔记本电脑的请求

使用自动化工作流来查询 Dell 服务有关保修详细信息并将该信息通过电子邮件发送给 IT 支持人员。
支持人员可以决定将其送去进行修理还是建议购买新电脑。

使用过程流程中的应用程序连接器的示例（故障单实现过程）

收到故障单后，分析人员可以触发自动化步骤以查询 dell 服务并更新该故障单上的保修详细信息。
可以通过建议购买新的笔记本电脑来关闭该故障单。
可以在完成修理后关闭该故障单。