Show Menu
主題×

使用Flow Service API建立通用OData連接器

Flow Service用於收集和集中Adobe Experience Platform內不同來源的客戶資料。 該服務提供用戶介面和REST風格的API,所有支援的源都可從中連接。
本教學課程使用Flow Service API來引導您完成將Generic OData連接至Experience Platform的步驟。

快速入門

本指南需要有效瞭解Adobe Experience Platform的下列元件:
  • 來源 :Experience Platform可讓您從各種來源擷取資料,同時讓您能夠使用平台服務來建構、標示和增強傳入資料。
  • 沙盒 :Experience Platform提供虛擬沙盒,可將單一Platform實例分割為不同的虛擬環境,以協助開發和發展數位體驗應用程式。
以下各節提供您需要知道的其他資訊,以便使用Flow Service API成功連線至OData。

收集必要的認證

為了使流服務與OData連接,您必須為以下連接屬性提供值:
憑證
說明
url
OData服務的根URL。
connectionSpec.id
建立連線所需的唯一識別碼。 OData的連接規範ID為: 8e6b41a8-d998-4545-ad7d-c6a9fff406c3
有關快速入門的詳細資訊,請參 閱此OData文檔

讀取範例API呼叫

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

收集必要標題的值

若要呼叫平台API,您必須先完成驗證教 學課程 。 完成驗證教學課程後,所有Experience Platform API呼叫中每個必要標題的值都會顯示在下方:
  • 授權:生產者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platform中的所有資源(包括屬於流服務的資源)都會隔離至特定的虛擬沙盒。 所有對平台API的請求都需要一個標題,該標題會指定要在中執行的操作的沙盒名稱:
  • x-sandbox-name: {SANDBOX_NAME}
所有包含裝載(POST、PUT、PATCH)的請求都需要額外的媒體類型標題:
  • 內容類型: 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,學習如何使 用Flow Service API來探索通訊協定應用程式