使用 PostgreSQL API创建连 Flow Service 接器

注意

连接 PostgreSQL 器为测试版。 有关使用 测试版标记 的连接器的更多信息,请参阅源概述。

Flow Service 用于收集和集中Adobe Experience Platform内不同来源的客户数据。 该服务提供用户界面和RESTful API,所有支持的源都可从中连接。

本教程使 Flow Service 用API指导您完成连接到的 Experience PlatformPostgreSQL 步骤(以下称“PSQL”)。

入门指南

本指南要求对Adobe Experience Platform的下列部分有工作上的理解:

  • 来源: Experience Platform 允许从各种来源摄取数据,同时使您能够使用服务来构建、标记和增强传入数 Platform 据。
  • 沙箱: Experience Platform 提供将单个实例分为单独的虚 Platform 拟环境的虚拟沙箱,以帮助开发和发展数字体验应用程序。

以下各节提供了使用API成功连接到PSQL所需了解的其他信 Flow Service 息。

收集所需的凭据

要连接 Flow Service PSQL,必须提供以下连接属性:

凭据 描述
connectionString 与您的PSQL帐户关联的连接字符串。 PSQL连接字符串模式为: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
connectionSpec.id 用于生成连接的ID。 PSQL的固定连接规范ID为 74a1c565-4e59-48d7-9d67-7c03b8a13137

有关获取连接字符串的详细信息,请参 阅此PSQL文档

读取示例API调用

本教程提供示例API调用,以演示如何设置请求的格式。 这包括路径、必需的标头和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的惯例的信息,请参阅疑难解答 指南中有关如何阅读示例API调 用 Experience Platform 一节。

收集所需标题的值

要调用API,您必 Platform 须先完成身份验证 教程。 完成身份验证教程可为所有API调用中的每个所需 Experience Platform 标头提供值,如下所示:

  • 授权:承载者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

中的所有资 Experience Platform源(包括属于这些资源 Flow Service的资源)都隔离到特定虚拟沙箱。 对API的 Platform 所有请求都需要一个标头,它指定操作将在中进行的沙箱的名称:

  • x-sandbox-name: {SANDBOX_NAME}

所有包含有效负荷(POST、PUT、PATCH)的请求都需要额外的媒体类型标头:

  • 内容类型: application/json

创建连接

连接指定源并包含该源的凭据。 每个PSQL帐户只需要一个连接,因为它可用于创建多个源连接器以导入不同的数据。

API格式

POST /connections

请求

要创建PSQL连接,其唯一连接规范ID必须作为POST请求的一部分提供。 PSQL的连接规范ID为 74a1c565-4e59-48d7-9d67-7c03b8a13137

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Test connection for PostgreSQL",
        "description": "Test connection for PostgreSQL",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "74a1c565-4e59-48d7-9d67-7c03b8a13137",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.connectionString 与您的PSQL帐户关联的连接字符串。 PSQL连接字符串模式为: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
connectionSpec.id PSQL的连接规范ID为: 74a1c565-4e59-48d7-9d67-7c03b8a13137.

响应

成功的响应会返回新创建的基id础连接的唯一标识符()。 在下一个教程中浏览PSQL数据库需要此ID。

{
    "id": "056dd1b4-da33-42f9-add1-b4da3392f94e",
    "etag": "\"1700e582-0000-0200-0000-5e3c85180000\""
}

后续步骤

通过本教程,您已使用API创建了PSQL Flow Service 连接,并已获得该连接的唯一ID值。 在下一个教程中,您可以使用此连接ID,因为您将学习 如何使用流服务API浏览数据库或NoSQL系统

在此页面上