串流內嵌驗證

串流內嵌可讓您使用串流端點即時將資料上傳至Adobe Experience Platform。 串流獲取API支援同步和非同步兩種驗證模式。

快速入門

本指南需要妥善了解下列Adobe Experience Platform元件：

• Experience Data Model (XDM) System:組織客戶體驗資 Experience Platform 料的標準化架構。
• Streaming Ingestion:資料可傳送至的方法之 Experience Platform一。

讀取範例API呼叫

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

收集必要標題的值

若要呼叫Platform API，您必須先完成authentication tutorial。 完成驗證教學課程後，將提供所有Experience Platform API呼叫中每個必要標題的值，如下所示：

• 授權：承載{ACCESS_TOKEN}
• x-api-key: {API_KEY}
• x-gw-ims-org-id: {IMS_ORG}

Experience Platform中的所有資源，包括屬於Schema Registry的資源，都會隔離至特定虛擬沙箱。 對Platform API的所有請求都需要標題，以指定作業將在下列位置進行的沙箱名稱：

• x-sandbox-name: {SANDBOX_NAME}

所有包含裝載(POST、PUT、PATCH)的請求都需要額外的標題：

• Content-Type: application/json

驗證涵蓋範圍

Streaming Validation Service 涵蓋下列方面的驗證：

• Range
• 是否存在
• 列舉
• 圖樣
• 類型
• 格式

同步驗證

同步驗證是一種驗證方法，可立即回饋擷取失敗的原因。 但是，失敗時，驗證失敗的記錄會遭到捨棄，且無法傳送至下游。 因此，同步驗證只應在開發程式期間使用。 執行同步驗證時，會通知呼叫者XDM驗證的結果，以及失敗的原因。

預設情況下，不會開啟同步驗證。 若要啟用此功能，您必須在進行API呼叫時傳遞選用的查詢參數syncValidation=true。 此外，目前只有在資料流端點位於VA7資料中心時，才可使用同步驗證。

如果訊息在同步驗證期間失敗，訊息將不會寫入輸出佇列，而會立即為使用者提供意見反應。

API格式

POST /collection/{CONNECTION_ID}?syncValidation=true

要求

提交下列請求，透過同步驗證將資料內嵌至您的資料入口：

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
  -H "Content-Type: application/json" \
  -d '{JSON_PAYLOAD}'

回應

啟用同步驗證後，成功的回應會在其裝載中包含任何遇到的驗證錯誤：

{
    "type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
    "status": 400,
    "title": "Invalid XDM Message Format",
    "report": {
        "message": "inletId: [6aca7aa2d87ebd6b2780ca5724d94324a14475f140a2b69373dd5c714430dfd4] imsOrgId: [7BF122A65C5B3FE40A494026@AdobeOrg] Message is invalid",
        "cause": {
            "_streamingValidation": [
                {
                    "schemaLocation": "#",
                    "pointerToViolation": "#",
                    "causingExceptions": [
                        {
                            "schemaLocation": "#",
                            "pointerToViolation": "#",
                            "causingExceptions": [],
                            "keyword": "additionalProperties",
                            "message": "extraneous key [workEmail] is not permitted"
                        },
                        {
                            "schemaLocation": "#",
                            "pointerToViolation": "#",
                            "causingExceptions": [],
                            "keyword": "additionalProperties",
                            "message": "extraneous key [person] is not permitted"
                        },
                        {
                            "schemaLocation": "#/properties/_id",
                            "pointerToViolation": "#/_id",
                            "causingExceptions": [],
                            "keyword": "type",
                            "message": "expected type: String, found: Long"
                        }
                    ],
                    "message": "3 schema violations found"
                }
            ]
        }
    }
}

上述回應會列出發現多少個架構違規，以及有哪些違規。 例如，此回應指出未在架構中定義鍵workEmail和person，因此不允許。 它也會將_id的值標示為不正確，因為架構應為string，但已插入long。 請注意，一旦遇到五個錯誤，驗證服務將​停止​處理該訊息。 不過，其他訊息會繼續剖析。

非同步驗證

非同步驗證是驗證方法，不會立即提供反饋。 而是將資料發送到Data Lake中的失敗批處理，以防止資料丟失。 稍後可以檢索此失敗資料，以便進一步分析和重播。 此方法應用於生產中。 除非另有要求，串流擷取會以非同步驗證模式運作。

API格式

POST /collection/{CONNECTION_ID}

要求

提交下列請求，透過非同步驗證將資料內嵌至您的資料入口：

curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID} \
  -H "Content-Type: application/json" \
  -d '{JSON_PAYLOAD}'

回應

啟用非同步驗證後，成功的回應會傳回下列內容：

{
    "inletId": "f6ca9706d61de3b78be69e2673ad68ab9fb2cece0c1e1afc071718a0033e6877",
    "xactionId": "1555445493896:8600:8",
    "receivedTimeMs": 1555445493932,
    "syncValidation": {
        "skipped": true
    }
}

請注意，響應如何表示已跳過同步驗證，因為尚未明確請求同步驗證。

附錄

本節包含各種狀態代碼對於擷取資料之回應有何意義的相關資訊。

狀態代碼