为 SAP HTTP API 配置并测试通用 HTTP 集成

前提条件

• 集成服务器已部署并在平台上注册，且可连接到 SAP HTTP API

• SAP 数据可通过标准 HTTP 调用获取

• RealityPlatform 上的资产设置访问权限

• 描述 HTTP API 的 OpenAPI 文档（v2.0、v3.0 或 v3.1）

  • 该文档可以是 YAML 或 JSON

  • 该文档可以本地存储在集成服务器的 Assets 文件夹内，也可以是 S3 URI

配置步骤

本指南将描述如何配置通用 HTTP 集成以在 RealityAsset 中检索数据。

配置 HTTP 集成的主要步骤如下：

1. 在 RealityPlatform 上注册 HTTP 数据源

2. 将集成链接到资产类型

3. 发送测试查询以验证与 API 的连接

针对没有直连连接器的系统的特殊注意事项

虽然本指南使用 SAP 作为参考示例，但相同的方法适用于任何没有直连连接器但可以通过 HTTP 公开其数据的系统。

在这种情况下，通常的做法是使用 HTTP 包装器（或 API 网关），通过标准 HTTP 调用公开系统的数据。许多企业平台——包括 SAP 产品——为此提供内置或附加功能，但也可以使用任何等效的解决方案。

集成要求：

• 必须支持基于令牌的身份验证。

• GET 请求是检索数据的首选，不过将来会支持其他 HTTP 动词和身份验证方法。

• 需要描述 API 的 OpenAPI 文档（版本 2.0、3.0 或 3.1）

在集成服务器上注册 HTTP 数据源

• 添加新数据源

• 选择 HTTP 类型

• 填写所需的参数以建立连接

HTTP 数据源参数

{
  "type": "HTTP",
  "name": "Example HTTP Data Source",
  "baseUrl": "https://example.com",
  "allowInsecure": false,
  "authBearerToken": "exampleBearerToken",
  "authBasic": "exampleBasicAuth",
  "schemaFile": "path/to/openapi/specification",
  "customAuthenticationHeader": {
    "Custom-Header": "HeaderValue"
  }
}

baseUrl

HTTP 数据源的基础 URL。

allowInsecure

允许集成服务器查询具有无效或自签名证书的 Web 服务器。

schemaFile

描述 HTTP API 的架构文件。

authBearerToken（可选）

用于身份验证的 bearer 令牌（如适用）。

authBasic（可选）

基本身份验证信息（如适用）。

customAuthenticationHeader（可选）

作为键值对记录的自定义身份验证标头（如适用）。

注意

• OpenAPI 规范可以在集成服务内提供，路径应在 “schemaFile” 配置参数中。实现此目的最简单的方法是将文件存储到集成服务内部文件系统，并在配置中简单地提供相对路径。

• 也可以将 OpenAPI 规范存储在 AWS S3 内，并将 S3 URI 提供给集成服务器。你必须确保集成服务器可以从 AWS S3 读取该文档。

将资产类型属性与 HTTP 链接

在链接之前，请确保你拥有：

• 一个现有的资产类型，其中有一个属性用于保存所需的 HTTP 参数值（例如 Asset ID）。它必须是 “Short text” 属性类型。

• 一个配置了 HTTP 数据源和查询的集成服务器。

要将资产类型属性链接到 HTTP：

1. 在资产设置 → 资产类型中，打开你想要链接的资产类型。

2. 在 Integration Links 面板（右侧），点击 Create Integration Link。

   

3. 输入链接名称并选择为 AWS IOT SiteWise 配置的集成服务器。

4. 选择适当的数据源

5. 选择所需的查询

6. 对于每个所需参数（例如 id），选择应提供其值的资产类型属性（例如 Id）。

   

7. 点击 Save 以创建链接。

将此资产类型分配给资产后，运行集成时链接的属性值将自动通过 HTTP 传递。

发送测试查询以验证 RealityPlatform 和 HTTP 数据源之间的连接

1. 在资产类型设置页面上，点击针对 HTTP 数据源的集成链接旁边的播放按钮。这将打开测试查询菜单。

2. 在 Parameters 配置下输入有效参数，然后点击 Test query 查看结果。如果 HTTP 不需要参数，请求将自动执行并显示结果。

注意

• 此处输入的值仅用于测试目的。它们不会保存到资产类型或链接的资产。此测试模拟当创建资产、分配此资产类型并填写相应属性（例如 id）时 RealityTwin 将执行的操作。使用任何有效参数来验证连接。