使用 Couchbase API建立連 Flow Service 接器

注意

連接 Couchbase 器為測試版。 如需使用 測試版標籤連接器的詳細資訊 ,請參閱來源概觀。

Flow Service 用來收集和集中來自不同來源的客戶資料,以便匯入Adobe Experience Platform。 該服務提供用戶介面和REST風格的API,所有支援的源都可從中連接。

本教學課程使用Flow Service API來引導您完成連線至的 Couchbase 步驟 Experience Platform。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:

  • 來源: Experience Platform 允許從各種來源接收資料,同時提供使用服務構建、標籤和增強傳入資料的 Platform 能力。
  • 沙盒: Experience Platform 提供虛擬沙盒,可將單一執行個體分 Platform 割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。

以下各節提供您必須知道的其他資訊,以便使用 CouchbaseFlow Service API成功連線至。

收集必要的認證

憑證 說明
connectionString 用來連線至您例項的連線 Couchbase 字串。 的連接字串模 Couchbase 式是 Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];。 有關獲取連接字串的詳細資訊,請參 閱此Couchbase文檔
connectionSpec.id 建立連線所需的識別碼。 的固定連接規範ID Couchbase 為 1fe283f6-9bec-11ea-bb37-0242ac130002

讀取範例API呼叫

本教學課程提供範例API呼叫,以示範如何設定請求的格式。 這些包括路徑、必要標題和正確格式化的請求負載。 也提供API回應中傳回的範例JSON。 如需範例API呼叫檔案中所用慣例的詳細資訊,請參閱疑難排解指 南中有關如何讀取範例API呼叫的 Experience Platform 章節。

收集必要標題的值

若要呼叫API,您必 Platform 須先完成驗證教 學課程。 完成驗證教學課程後,將提供所有 Experience Platform API呼叫中每個必要標題的值,如下所示:

  • 授權:生產者 {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

建立連線

連接指定源,並包含該源的憑據。 每個帳戶只需要一個連 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\""
}

後續步驟

在本教學課程中,您已使 Couchbase 用 Flow Service API建立連線,並取得連線的唯一ID值。 在下一個教學課程中,您可以使用此ID來學習如何使 用Flow Service API來探索資料庫

本頁內容