使用Flow Service API建立Generic OData來源連線

注意

Generic OData介面處於測試狀態。 有關使用beta標籤連接器的詳細資訊，請參閱 Sources綜覽。

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

本教學課程使用Flow Service API來引導您完成將Generic OData連接至Experience Platform的步驟。

快速入門

本指南需要對Adobe Experience Platform的下列組成部分有切實的瞭解：

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

以下各節提供您需要瞭解的其他資訊，以便使用Flow Service API成功連線至OData。

收集必要的認證

要使Flow Service與OData連接，必須為以下連接屬性提供值：

憑證 說明
url OData服務的根URL。
connectionSpec.id 建立連線所需的唯一識別碼。 OData的連接規範ID為：8e6b41a8-d998-4545-ad7d-c6a9fff406c3

有關入門的詳細資訊，請參閱此OData文檔。

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

建立連線

連接指定源，並包含該源的憑據。 每個OData帳戶只需要一個連接，因為它可用於建立多個源連接器以導入不同的資料。

API格式

POST /connections

要求

要建立OData連接，必須在POST請求中提供其唯一連接規範ID。 OData的連接規範ID為8e6b41a8-d998-4545-ad7d-c6a9fff406c3。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/connections' \
    -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}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Protocols",
        "description": "A test connection for a Protocols source",
        "auth": {
            "specName": "Anonymous Authentication",
        "params": {
            "url" :  "{URL}"
            }
        },
        "connectionSpec": {
            "id": "8e6b41a8-d998-4545-ad7d-c6a9fff406c3",
            "version": "1.0"
        }
    }'
屬性 說明
auth.params.url OData伺服器的主機。
connectionSpec.id OData連接規範ID:8e6b41a8-d998-4545-ad7d-c6a9fff406c3。

回應

成功的響應返回新建立的連接，包括其唯一連接標識符(id)。 在下一個教學課程中探索資料時，需要此ID。

{
    "id": "a5c6b647-e784-4b58-86b6-47e784ab580b",
    "etag": "\"7b01056a-0000-0200-0000-5e8a4f5b0000\""
}

後續步驟

在本教程中，您使用Flow Service API建立了OData連接，並獲取了該連接的唯一ID值。 在下一個教學課程中，您可以使用此ID，學習如何使用流服務API🔗來探索通訊協定應用程式。

本頁內容