创建 HTTP 集成

现在您已经确定了 API,让我们将 HTTP 集成添加到 微应用中。

要创建 HTTP 集成,请执行以下操作:

  1. 在“微应用概览”页面中,选择开始管理

    此时将打开“微应用集成”页面。

  2. 选择添加集成
  3. 选择创建到 HTTP Web 服务的新集成以添加配置详细信息。

    HTTP 磁贴

  4. 为您的集成指定一个名称,然后输入您收集的基本 URL。基本 URL 是您将用于此集成的 Web 地址的一致部分。

    每次集成只能添加一个基本 URL。如果您需要更多的基本 URL,则必须创建另一个集成。

注意:

虽然 HTTP 和 HTTPS 都被允许作为基础 URL,但 HTTP 被认为是一种安全性低得多的连接方法,并且不太可能将它用于目标集成应用程序。

例如:

名称: Asana 集成

Base URL: https://app.asana.com/api/1.0/workspaces/${YOUR_WORKSPACE_ID}

注意:

在此示例中,将 ${YOUR_WORKSPACE_ID} 替换为您的工作区 ID(例如:419224638481718)。

设置服务身份验证

配置 HTTP 集成服务身份验证时,您已使用目标应用程序设置服务帐户,并根据目标应用程序的要求拥有必要的凭据。收集目标应用程序的所有必要信息(登录名、密码、安全凭据等)后,可以开始服务集成过程。

从以下选项中选择您的身份验证方法:

  • - 无需安全证书。
  • 基本 -使用目标应用程序的用户名和密码进行身份验证。
  • NTLM - 将 HTTP 集成配置为使用一套 Microsoft 协议通过新技术局域网管理器 (NTLM) 身份验证服务器进行连接,以通过 Microsoft Windows 凭据验证 NTLM 用户的身份。
  • 持有者 -将目标集成的身份验证方案配置为使用服务器生成的持有者令牌以响应登录请求。
  • OAuth 2.0 - 使用 OAuth 2.0 安全协议为委派访问生成请求/授权令牌。OAuth 2.0 实现因系统而异,但 OAuth 2.0 的常规工作流程如下所述。
  • API 密钥 -使用 API 密钥方法对用户、开发人员或调用程序对 API 进行身份验证。

注意:

建议您始终使用 OAuth 2.0 作为您的服务身份验证方法(如果可用)。OAuth 2.0 可确保您的集成符合您配置的微应用的最大安全合规性。

请按照以下步骤进行操作:

  1. 输入集成的服务身份验证参数。
  2. (可选)对于授权代码授权类型,选择使用您的服务帐户登录并等待登录完成。
  3. (可选)选择服务操作身份验证单选按钮,然后在服务操作级别输入身份验证参数。

    重要:

    如果您使用的是委派权限,则可能没有完全访问权限。在这种情况下,使用服务操作身份验证在服务操作级别进行身份验证。在这种情况下,您可以在服务级别使用基本身份验证,但出于安全原因,您必须在服务操作级别使用 OAuth 2.0。

  4. 选择添加

OAuth 2.0 身份验证

OAuth 2.0 使应用程序能够获得对第三方应用程序上 HTTP 服务用户帐户的特定访问权限。它的工作原理是将身份验证委派给包含用户帐户的服务,然后授权第三方应用程序访问该用户帐户。

OAuth 回调 URL

用于身份验证的回调 URL 遵循以下模式:

https://{customer_id}.{customer_geo}.iws.cloud.com/admin/api/gwsc/auth/serverContext,
https://{customer_id}.{customer_geo}.iws.cloud.com/app/api/auth/serviceAction/callback

此 URL 的第二部分仅在定义每个用户经过身份验证的操作时使用。客户和地理标识符对于每个客户来说都是可变的,并且是唯一的。

OAuth 2.0 授权类型

HTTP 集成允许您从三种授权类型中进行选择。设置 Oath 2.0 时,请从菜单中选择您的授权类型。配置 OAuth 2.0 时,我们建议您使用授权码,因为这是最安全的授权流。如果您需要其他服务操作身份验证方法,请使用客户端凭据和资源所有者密码授予类型:

  • 授权码 -授予客户端为访问令牌交换的临时代码。代码从授权服务器获取,您可以在其中查看客户端请求的信息。只有此授权类型才能启用安全的用户模拟。
  • 客户端凭据 -授予类型用于获取用户上下文之外的访问令牌。客户端使用此功能来访问其自己的资源,而不是访问用户的资源。
  • 资源所有者密码 -提供正确的凭据以授权资源服务器提供访问令牌。

授予类型输入

根据上面定义的授权类型,您将获得以下选项来完成以启用 OAuth 2.0 身份验证:

  • 令牌 URL -定义访问授权令牌的 URL。
  • 范围 -定义访问请求的范围,这是由授权服务器在设置目标集成应用程序时定义的字符串。
  • 客户端 ID -定义表示授权服务器唯一的客户端注册信息的字符串。
  • 客户端密码 -定义设置目标应用程序集成时发出的唯一字符串。
  • 用户名 - 定义目标应用程序帐户的用户名。
  • 密码 -定义目标应用程序帐户的密码。
  • 授权 URL -定义设置目标应用程序集成时提供的授权服务器 URL。
  • 访问令牌参数 -根据目标应用程序授权服务器的要求定义访问令牌参数(如有必要)。
  • 使用您的服务帐户登录 - 登录目标应用程序授权服务器的服务帐户。
  • 标题前缀 -(可选)如果承载人前缀与默认标题不同,则输入标题前缀。

有关 OAuth 2.0 的额外资源可以在 OAuth 2.0 的 请求提问 页面找到。

OAuth 2.0 故障排除

如果您在将目标应用程序连接到微应用平台时遇到问题,请根据您自己的配置检查以下可能的解决方案错误:

  • invalid_request -您的授权请求可能会错过所需参数、包含不支持的参数值(或其他授权类型)、重复参数、包含多个凭据、利用多个机制对客户端进行身份验证。
  • invalid_client -由于以下原因,您的客户端身份验证失败:未知客户端、不包括客户端身份验证或不支持的身份验证方法。授权服务器可能会返回 HTTP 401(未授权)状态代码,以指示支持哪些 HTTP 身份验证方案。
  • invalid _grant -授权授权或刷新令牌可能无效、已过期、已撤销,与授权请求中使用的重定向 URI 发出给另一个客户端。
  • unauthorized_client -未授权经过身份验证的客户端使用此授权授权类型。
  • unsupported_grant_type -授权服务器不支持授权类型。
  • invalid _scope -请求的作用域无效、未知、格式错误或超出资源所有者授予的作用域。

如果配置 OAuth 2.0 时仍然遇到问题,请检查是否为令牌和授权 URL 输入了正确的 URL,因为这两者都是唯一的。还要重新检查您的其他输入是否正确,例如 Scope 等。如果问题仍然存在,请检查集成应用程序服务器端的设置。

本地实例(技术预览版)

微应用还允许您连接本地记录系统 (SoR)。

如果要创建本地连接,请首先使用 Citrix Cloud Connector 设备进行连接

若要查找此请登录到 Citrix Cloud

  1. 资源位置选项卡中选择编辑或新增
  2. 从列表中查找您的微应用资源。
  3. 单击 ID
  4. 将资源标识符 ID 复制到 微应用中的本地资源位置: 已配置您的本地集成。

注意

本地功能启用目前仅作为技术预览提供。 默认情况下,本地处于隐藏状态,并且必须在 Citrix Cloud 操作控制板中启用连接器设备的功能名称。 启用此功能后,更改将在不到一小时的时间内传播(在 Citrix 端缓存已启用的功能)。 本地当前仅支持 HTTP 集成和 Jira 集成,只支持 HTTPS 协议与记录系统 (SoR) 进行通信。

下一步的去向

现在您已创建 HTTP 集成,请配置集成: