使用Flow Service API创建Couchbase连接器

注意

Couchbase接头为测试版。 有关使用测试版标签的连接器的详细信息，请参见源概述。

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

本教程使用Flow Service API指导您完成将Couchbase连接到Experience Platform的步骤。

入门指南

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

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

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

收集所需的凭据

凭据 描述
connectionString 用于连接到Couchbase实例的连接字符串。 Couchbase的连接字符串模式为Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];。 有关获取连接字符串的详细信息，请参阅此Couchbase文档。
connectionSpec.id 创建连接所需的标识符。 Couchbase的固定连接规范ID为1fe283f6-9bec-11ea-bb37-0242ac130002。

读取示例API调用

本教程提供示例API调用，以演示如何设置请求的格式。 这包括路径、必需的标头和格式正确的请求负载。 还提供API响应中返回的示例JSON。 有关示例API调用文档中使用的约定的信息，请参见](…/…/…/…/…/landing/troubleshooting.md#how-do-i-format-an-api-request)疑难解答指南中关于如何阅读示例API调用[的一节。Experience Platform

收集所需标题的值

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

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有资源（包括属于Flow Service的资源）都隔离到特定虚拟沙箱。 对Platform API的所有请求都需要一个标头，它指定操作将在以下位置进行的沙箱的名称：

  • x-sandbox-name: {SANDBOX_NAME}

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

  • Content-Type: application/json

创建连接

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

API格式

POST /connections

请求

以下请求创建新的Couchbase连接，该连接由负载中提供的属性进行配置：

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": "Couchbase test connection",
        "description": "A test connection for a Couchbase source",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                    "connectionString": "Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];"
                }
        },
        "connectionSpec": {
            "id": "1fe283f6-9bec-11ea-bb37-0242ac130002",
            "version": "1.0"
        }
    }'
属性 描述
auth.params.connectionString 用于连接到Couchbase帐户的连接字符串。 连接字符串模式为：Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];。
connectionSpec.id Couchbase连接规范ID:1fe283f6-9bec-11ea-bb37-0242ac130002。

响应

成功的响应会返回新创建的连接的详细信息，包括其唯一标识符(id)。 在下一个教程中浏览数据时需要此ID。

{
    "id": "54997109-07b5-40b7-9971-0907b5a0b75a",
    "etag": "\"280168f5-0000-0200-0000-5ed72b230000\""
}

后续步骤

按照本教程，您已使用Flow Service API创建了Couchbase连接，并已获得该连接的唯一ID值。 在下一个教程中，您可以使用此ID，因为您正在学习如何使用流服务API浏览数据库。

在此页面上