使用Flow Service API探索行銷自動化系統

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

本教學課程使用Flow Service API來探索行銷自動化系統。

快速入門

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

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

以下各節提供您需要瞭解的其他資訊，以便使用Flow Service API成功連線至行銷自動化系統。

收集必要的認證

本教學課程要求您必須與想要從中擷取資料的第三方行銷自動化應用程式建立有效的連線。有效連接涉及應用程式的連接規範ID和連接ID。有關建立行銷自動化連線及擷取這些值的詳細資訊，請參閱將行銷自動化來源連接至Platform教學課程。

讀取範例API呼叫

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

收集必要標題的值

若要呼叫Platform API，您必須先完成驗證教學課程。完成驗證教學課程後，所有Experience Platform API呼叫中每個所需標題的值都會顯示在下面：

授權：載體{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)的請求都需要額外的媒體類型標題：

內容類型：application/json

探索您的資料表格

使用行銷自動化系統的基本連線，您可以執行GET請求來探索資料表。使用以下調用查找要檢查或裝入Platform的表的路徑。

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

參數	說明
`{BASE_CONNECTION_ID}`	行銷自動化系統的基本連線ID。

請求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=root' \
    -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}'

回應

成功的回應是從您的行銷自動化系統傳送的一連串表格。查找要帶入Platform的表，並記下其path屬性，因為在下一步中需要提供該表來檢查其結構。

[
    {
        "type": "table",
        "name": "Hubspot.All_Deals",
        "path": "Hubspot.All_Deals",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Authors",
        "path": "Hubspot.Blog_Authors",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Comments",
        "path": "Hubspot.Blog_Comments",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Contacts",
        "path": "Hubspot.Contacts",
        "canPreview": true,
        "canFetchSchema": true
    },
]

檢查表格結構

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

API格式

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

參數	說明
`{BASE_CONNECTION_ID}`	行銷自動化系統的連線ID。
`{TABLE_PATH}`	行銷自動化系統中表格的路徑。

請求

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
    -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}'

回應

成功的響應返回表的結構。有關每個表列的詳細資訊位於columns陣列的元素中。

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Properties_Firstname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Properties_Lastname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Added_At",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            {
                "name": "Portal_Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}