使用Flow Service API探索資料庫

本教學課程使用Flow Service API來探索協力廠商資料庫的內容和檔案結構。

快速入門

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

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

以下各節提供您必須知道的其他資訊，以便使用Flow Service API成功連線至協力廠商資料庫。

收集必要的認證

本教學課程要求您必須與要從中收錄資料的第三方資料庫建立有效的連線。有效連接涉及資料庫的連接規範ID和連接ID。有關建立資料庫連接和檢索這些值的詳細資訊，請參閱源連接器概述。

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

探索您的資料表格

使用資料庫的連接ID，可以通過執行GET請求來瀏覽資料表。使用以下調用查找要檢查或裝入Platform的表的路徑。

API格式

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

參數	說明
`{BASE_CONNECTION_ID}`	資料庫源的連接ID。

請求

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/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": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "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 \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -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": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}