使用Flow Service API探索通訊協定系統

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：

建立對象：

undefined

Flow Service用於收集及集中來自Adobe Experience Platform內各種不同來源的客戶資料。此服務提供使用者介面和RESTful API，所有支援的來源都可從此API連線。

此教學課程使用Flow Service API來探索通訊協定應用程式。

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件：

來源： Experience Platform允許從各種來源擷取資料，同時讓您能夠使用Platform服務來建構、加標籤以及增強傳入的資料。
沙箱： Experience Platform提供可將單一Platform執行個體分割成個別虛擬環境的虛擬沙箱，以利開發及改進數位體驗應用程式。

下列章節提供您需瞭解的其他資訊，才能使用Flow Service API成功連線到通訊協定應用程式。

取得基礎連線

若要使用Platform API探索您的通訊協定系統，您必須擁有有效的基底連線識別碼。如果您尚未建立要使用的通訊協定系統的基礎連線，您可以透過下列教學課程來建立基礎連線：

通用OData

讀取範例 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： {ORG_ID}

Experience Platform中的所有資源（包括屬於Flow Service的資源）都與特定的虛擬沙箱隔離。對Platform API的所有請求都需要標頭，以指定將在其中執行作業的沙箱名稱：

x-sandbox-name： {SANDBOX_NAME}

包含裝載(POST、PUT、PATCH)的所有請求都需要額外的媒體型別標頭：

Content-Type： application/json

探索您的資料表

使用通訊協定應用程式的連線ID，您可以透過執行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/a5c6b647-e784-4b58-86b6-47e784ab580b/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}'

回應

成功的回應會從您的通訊協定應用程式傳回資料表陣列。尋找您要帶入Platform的資料表並記下其path屬性，因為您必須在下個步驟中提供它以檢查其結構。

[
    {
        "type": "table",
        "name": "Categories",
        "path": "Categories",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "CustomerDemographics",
        "path": "CustomerDemographics",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Customers",
        "path": "Customers",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Orders",
        "path": "Orders",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspect表格的結構

若要從通訊協定應用程式中檢查表格的結構，請在將表格的路徑指定為查詢引數時執行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/a5c6b647-e784-4b58-86b6-47e784ab580b/explore?objectType=table&object=Orders' \
    -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": "OrderID",
                "type": "integer",
                "xdm": {
                    "type": "integer",
                    "minimum": -2147483648,
                    "maximum": 2147483647
                }
            },
            {
                "name": "CustomerID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "EmployeeID",
                "type": "integer",
                "xdm": {
                    "type": "integer",
                    "minimum": -2147483648,
                    "maximum": 2147483647
                }
            },
            {
                "name": "OrderDate",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
        ]
    }
}

後續步驟

依照本教學課程，您已探索您的通訊協定應用程式、找到您要擷取至Platform的表格路徑，並取得有關其結構的資訊。您可以在下個教學課程中使用此資訊，從您的通訊協定應用程式收集資料，並將其帶入Platform。

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089