使用Flow Service API建立Phoenix連接器

注意

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

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

本教程使用Flow Service API來引導您完成將Phoenix資料庫連接到Experience Platform的步驟。

快速入門

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

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

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

收集必要的認證

要使Flow Service與Phoenix連接,必須為以下連接屬性提供值:

憑證 說明
host Phoenix伺服器的IP地址或主機名。
username 用於訪問Phoenix伺服器的用戶名。
password 與用戶對應的密碼。
port Phoenix伺服器用於偵聽客戶機連接的TCP埠。 如果您連線至Azure HDInsights,請將埠指定為443。
httpPath 與Phoenix伺服器對應的部分URL。 如果使用Azure HDInsights叢集,請指定/hbasephoenix0。
enableSsl 布林值。 指定是否使用SSL加密與伺服器的連線。
connectionSpec.id 建立連線所需的唯一識別碼。 Phoenix的連接規範ID為:102706fb-a5cd-42ee-afe0-bc42f017ff43

有關開始使用的詳細資訊,請參閱本Phoenix檔案

讀取範例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

建立連線

連接指定源,並包含該源的憑據。 每個Phoenix帳戶只需要一個連接,因為它可用於建立多個源連接器以導入不同的資料。

API格式

POST /connections

請求

要建立Phoenix連接,必須在POST請求中提供其唯一連接規範ID。 Phoenix的連接規範ID為102706fb-a5cd-42ee-afe0-bc42f017ff43

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": "Phoenix test connection",
        "description": "Phoenix test connection",
        "auth": {
            "specName": "Basic Authentication",
        "params": {
            "host" :  "{HOST}",
            "username" : "{USERNAME}",
            "password" :"{PASSWORD}",
            "port" : {PORT},
            "httpPath" : "{PATH}",
            "enableSsl" : {SSL}
            }
        },
        "connectionSpec": {
            "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
            "version": "1.0"
        }
    }'
屬性 說明
auth.params.host Phoenix伺服器的主機。
auth.params.username 與Phoenix連接關聯的用戶名。
auth.params.password 與Phoenix連接關聯的口令。
auth.params.port Phoenix連接的TCP埠。
auth.params.httpPath Phoenix連接的部分http路徑。
auth.params.enableSsl 此布爾值指定是否使用SSL加密與伺服器的連接。
connectionSpec.id Phoenix連接規範ID:102706fb-a5cd-42ee-afe0-bc42f017ff43

回應

成功的響應返回新建立的連接的詳細資訊,包括其唯一標識符(id)。 在下一個教學課程中探索資料時,需要此ID。

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

後續步驟

在本教程中,您使用Flow Service API建立了Phoenix連接,並獲取了該連接的唯一ID值。 在下一個教學課程中,您可以使用此ID來學習如何使用流服務API來探索資料庫。

本頁內容