使用 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調用文檔中使用的約定的資訊，請參見上的 如何讀取示例API調用 的 Experience Platform 疑難解答指南。

收集所需標題的值

為了呼叫 Platform API，必須首先完成 驗證教程。 完成身份驗證教程將提供所有E中每個必需標頭的值xperience Platform API調用，如下所示：

  • Authorization: Bearer {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 \
    '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: {ORG_ID}' \
    -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
    }
]

Inspect桌子的結構

要從資料庫中檢查表的結構，請在將表的路徑指定為查詢參數時執行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: {ORG_ID}' \
    -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"
                }
            }
        ]
    }
}

後續步驟

通過遵循本教程，您已瀏覽了資料庫，找到了要插入的表的路徑 Platform並獲取了有關其結構的資訊。 您可以在下一教程中使用此資訊 從資料庫中收集資料並將其放入平台。

本頁內容