使用探索客戶成功系統 Flow Service API

Flow Service 可用來收集和集中Adobe Experience Platform中各種不同來源的客戶資料。 該服務提供用戶介面和RESTful API，所有受支援的源都可從中連接。

本教學課程使用 Flow Service 探索Customer Success(CS)系統的API。

快速入門

本指南需要妥善了解下列Adobe Experience Platform元件：

  • 來源: Experience Platform 可讓您從各種來源擷取資料，同時使用來建構、加標籤及增強傳入資料 Platform 服務。
  • 沙箱: Experience Platform 提供可分割單一沙箱的虛擬沙箱 Platform 例項放入個別的虛擬環境，以協助開發及改進數位體驗應用程式。

以下各節提供您需要知道的其他資訊，以便使用成功連接到CS系統 Flow Service API。

獲取基本連接

為探索您的CS系統，請使用 Platform API，您必須擁有有效的基本連線ID。 如果您尚沒有要使用的CS系統的基本連接，則可以通過以下教程建立一個連接：

讀取範例API呼叫

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

收集必要標題的值

若要對 Platform API，您必須先完成 驗證教學課程. 完成驗證教學課程會提供所有 Experience Platform API呼叫，如下所示：

  • 授權：承載 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

中的所有資源 Experience Platform，包括 Flow Service，會與特定虛擬沙箱隔離。 所有請求 Platform API需要標頭，以指定要在中執行操作的沙箱名稱：

  • x-sandbox-name: {SANDBOX_NAME}

所有包含裝載(POST、PUT、PATCH)的請求都需要其他媒體類型標題：

  • Content-Type: application/json

探索資料表

使用CS系統的基本連接，可以通過執行GET請求來瀏覽資料表。 使用以下調用查找要檢查或將其嵌入的表的路徑 Platform.

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
參數 說明
{BASE_CONNECTION_ID} CS基連接的ID。

要求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=root' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的響應從CS系統返回表陣列。 找到要放進的桌子 Platform 並注意 path 屬性，因為您必須在下一個步驟中提供屬性，以檢查其結構。

[
    {
        "type": "table",
        "name": "Accepted Event Relation",
        "path": "AcceptedEventRelation",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Account",
        "path": "Account",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Account Change Event",
        "path": "AccountChangeEvent",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Account Clean Info",
        "path": "AccountCleanInfo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表的結構

要從CS系統檢查表的結構，請在指定表的路徑作為查詢參數時執行GET請求。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
參數 說明
{BASE_CONNECTION_ID} CS基連接的ID。
{TABLE_PATH} 表的路徑。 
curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/60a5c8b9-3c30-43ba-a5c8-b93c3093ba66/explore?objectType=table&object=test1.Mytable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的響應返回指定表的結構。 有關表格各欄的詳細資訊位於 columns 陣列。

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Phone",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}

後續步驟

依照本教學課程，您已探索您的CS系統，找到您要內嵌至的表格路徑 Platform，並取得其結構的相關資訊。 您可以在下一個教學課程中使用此資訊，以 從您的CS系統收集資料並匯入Platform.

本頁內容