连接到 REST API

该 REST API 连接器需要特定信息才能在 Data Virtualization. 中建立与其的连接。

有关更多信息，请参阅对象存储中的数据源。 Data Virtualization

开始之前

您需要以下连接信息来建立与 的连接 REST API：
  • 主机名 URL

过程

要连接到 REST API ， Data Virtualization 请按照以下步骤操作。

  1. 在导航菜单中， 单击“数据” > Data virtualization。 此时将显示“数据源”页面。

  2. 单击 “添加连接 ”> “新建连接 ”以查看数据源列表。

  3. 选择 REST API 数据源连接。

  4. 输入连接名称和描述。

  5. 输入您的主机 URL 数据库。 您可以选择两种方法来设置与数据源 REST API 的连接：Sample 属性方法和模型文件方法。
    示例属性方法
    若使用示例属性方法，请为主机名指定一个端点，例如 URL ： https://domain.example.com/api/v1/employee_name。 Sample属性方法允许通过最少的配置访问来自单个端点的数据。 您无需提供模型文件。
    模型文件方法
    注意： 从 Cloud Pak for Data 版本 5.0.3 开始，您可以下载自主REST设计器（ARC）工具来创建和编辑模型文件。 转到数据源页面，选择添加连接 > 下载ARC工具。
    • 若使用模型文件方法，请输入主机名的 URL 基准部分（https://domain.example.com），以便访问来自多个端点的数据。
    • 对于此方法，您需要手动创建模型文件，然后将该文件粘贴到模型文件字段中。 要创建模型文件并将端点映射到表 ， 请按照模型文件语法中的步骤操作 有关将端点映射到表的基本格式的参考，请参阅创建模型文件中的示例。
    • 您可以修改模型文件以适应您的环境，例如驱动程序如何处理 HTTP 状态代码，或针对GET请求的不同配置。 对于数据源 REST API ，您无需使用示例模型文件中展示的POST请求或身份验证对象。

  6. 根据您的版本完成以下 Cloud Pak for Data任务。

    • 在 Cloud Pak for Data 版本 或 5.0.25.0.1 中，您可以创建基于 API 5.0.0 密钥认证的 REST API 连接，或使用其他认证方法。

      使用配置为查询参数的API密钥认证
      要使用 API 密钥认证，请在完成以下步骤前确保您的数据源支持将 API 密钥作为查询参数传递。
      1. 要使用 API 密钥认证，请将 API 密钥直接添加到主机中 URL。
        例如：在此示例中 URL ，您需要将 <your_api_key> 替换为实际的API密钥。
        https://api.example.com/resource?apikey=<your_api_key>
      2. 在凭据中，选择 “无” 作为您的身份验证方法。
      使用其他身份验证方法（基本身份验证、无身份验证或承载令牌）

      要使用其他身份验证方法，请完成以下步骤。

      1. 请勿进入附加属性。 此字段不支持。
      2. 在凭据中，选择您的身份验证方法（基本、无或承载令牌），并提供所需的凭据。
    • 从 Cloud Pak for Data 版本 5.0.3 及更高版本开始，您不仅可以完成先前版本中的相同任务，还可通过将基于API密钥的身份验证配置为标头参数，创建REST API连接。

      使用作为标头参数配置的API密钥认证
      要使用配置为标头参数的 API 密钥身份验证，请完成以下步骤。
      1. 在 “附加属性 ”字段中，输入以下参数。 请将 <your_api_key> 替换为您的API密钥。
        AuthenticationMethod=HttpHeader;SecurityToken=ApiKey<your_api_key>
      2. 在凭据中，选择 “无” 作为您的身份验证方法。

  7. 如果连接需要自定义 SSL 证书，请在 SSL 证书字段中输入该证书。

  8. 点击创建以将连接添加到数据源环境。

结果

现在，您可以在 中将 REST API 用作数据源 Data Virtualization。