使用Flow Service API建立Couchbase連接器

注意

Couchbase介面處於測試狀態。 有關使用beta標籤連接器的詳細資訊,請參閱來源概觀

Flow Service 用來收集和集中來自不同來源的客戶資料,以便匯入Adobe Experience Platform。該服務提供用戶介面和REST風格的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呼叫檔案中所用慣例的詳細資訊,請參閱Experience Platform疑難排解指南中如何讀取範例API呼叫一節。

收集必要標題的值

若要呼叫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來探索資料庫。

本頁內容