Platform 常見問題解答和故障排除指南

本文檔提供有關Adobe Experience Platform的常見問題的解答,並提供高級故障排除指南,以瞭解在任何情況下可能遇到的常見錯誤 Experience Platform API。 有關各個故障排除指南的資訊 Platform 服務,請參閱 服務疑難解答目錄 下。

常見問題集

以下是關於Adobe Experience Platform的常見問題解答清單。

什麼是 Experience Platform API?

Experience Platform 提供多個使用HTTP請求訪問的REST風格API Platform 資源。 這些服務API每個都會顯示多個端點,並允許您執行清單(GET)、查找(GET)、編輯(PUT和/或PATCH)和刪除(DELETE)資源的操作。 有關每個服務的特定終結點和操作的詳細資訊,請參閱 API參考文檔 Adobe I/O。

如何格式化API請求?

請求格式因 Platform 正在使用的API。 學習如何構造API調用的最佳方法是,隨附特定API調用文檔中提供的示例 Platform 服務。

有關建立API請求的詳細資訊,請訪問平台API入門指南 讀取示例API調用 的子菜單。

我的IMS組織是什麼?

IMS組織是客戶的Adobe代表。 任何經許可的Adobe解決方案都與此客戶組織整合。 當網際網路管理系統組織有權 Experience Platform,它可以將訪問權限分配給開發人員。 IMS組織ID(x-gw-ims-org-id)表示應為執行API調用的組織,因此在所有API請求中都需要作為標頭。 此ID可通過 Adobe Developer控制台:的 整合 頁籤,導航到 概述 的ID 客戶端憑據。 有關如何驗證到 Platform,請參見 驗證教程

在哪裡可以找到我的API密鑰?

所有API請求中都需要API密鑰作為頭。 可以通過 Adobe Developer控制台。 在控制台中, 整合 頁籤,導航到 概述 的下一頁,您將在 客戶端憑據。 有關如何驗證到的逐步步驟 Platform,請參見 驗證教程

如何獲得訪問令牌?

所有API調用的授權標頭中都需要訪問令牌。 可使用 curl 命令,前提是您有權訪問IMS組織的整合。 訪問令牌僅有24小時有效,此後必須生成新令牌才能繼續使用API。 有關生成訪問令牌的詳細資訊,請參閱 驗證教程

如何使用查詢參數?

部分 Platform API端點接受查詢參數以定位特定資訊並過濾在響應中返回的結果。 查詢參數將附加在帶有問號(?)符號,後跟一個或多個查詢參數,使用格式 paramName=paramValue。 在單個調用中組合多個參數時,必須使用「和」符號(&)以分離各個參數。 下面的示例演示如何使用多個查詢參數的請求在文檔中的表示方式。

常用查詢參數的示例包括:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

有關特定服務或端點可用的查詢參數的詳細資訊,請查看特定於服務的文檔。

如何指示要在PATCH請求中更新的JSON欄位?

許多PATCH操作 Platform API使用 JSON指針 字串,以指示要更新的JSON屬性。 這些通常包含在請求負載中,使用 JSON修補程式 的子菜單。 查看 API基礎指南 的子菜單。

我能用Postman打電話給 Platform API?

Postman 是用於可視化對REST風格API的調用的有用工具。 的 平台API入門指南 包含用於導入Postman收藏的視頻和說明。 此外,還提供了每項服務的Postman收藏清單。

系統要求 Platform?

根據您是使用UI還是API,應用以下系統要求:

對於基於UI的操作:

  • 現代標準的Web瀏覽器。 而 Chrome 建議,當前和以前的主要版本 Firefox。 Internet Explorer,也支援Safari。
    • 每次新的主版本發佈, Platform 開始支援最新版本,同時放棄對第三個最新版本的支援。
  • 所有瀏覽器都必須啟用Cookie和JavaScript。

對於API和開發人員交互:

  • 為REST、流和Webhook整合開發的開發環境。

錯誤和故障排除

以下是使用任何 Experience Platform 服務。 有關各個故障排除指南的資訊 Platform 服務,請參閱 服務疑難解答目錄 下。

API狀態代碼

在任何 Experience Platform API。 各有各種原因,因此本節的解釋具有一般性。 有關單個中特定錯誤的詳細資訊 Platform 服務,請參閱 服務疑難解答目錄 下。

狀態代碼 說明 可能的原因
400 錯誤請求 請求構造不正確、缺少關鍵資訊和/或包含不正確的語法。
401 身份驗證失敗 請求未通過身份驗證檢查。 您的訪問令牌可能丟失或無效。 查看 OAuth標籤錯誤 的子菜單。
403 禁止 已找到該資源,但您沒有查看該資源的正確憑據。
404 未找到 在伺服器上找不到請求的資源。 資源可能已被刪除,或請求的路徑輸入不正確。
500 內部伺服器錯誤 這是伺服器端錯誤。 如果同時進行許多調用,則可能已達到API限制,需要篩選結果。 (請參閱 Catalog Service API開發人員指南子指南 過濾資料 瞭解更多資訊。) 請等待片刻,然後再次嘗試您的請求,如果問題仍然存在,請與管理員聯繫。

請求標頭錯誤

中的所有API調用 Platform 需要特定的請求標頭。 要查看各個服務需要哪些標頭,請參閱 API參考文檔。 要查找所需驗證標頭的值,請參閱 驗證教程。 如果在進行API調用時丟失或無效這些標頭中的任何一個,則可能會出現以下錯誤。

缺少OAuth令牌

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Authorization API請求中缺少標頭。 在重試之前,請確保授權標頭包含有效的訪問令牌。

OAuth令牌無效

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

在中提供的訪問令牌 Authorization 標頭無效。 確保已正確輸入令牌,或 生成新令牌 的下界。

需要API密鑰

{
    "error_code": "403000",
    "message": "Api Key is required"
}

當API密鑰標頭(x-api-key)在API請求中缺失。 在重試之前,請確保標頭包含有效的API密鑰。

API密鑰無效

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

當提供的API密鑰標頭的值(x-api-key)無效。 請確保在再次嘗試之前已正確輸入密鑰。 如果您不知道您的API密鑰,則可以在 Adobe I/O控制台:的 整合 頁籤,導航到 概述 的子目錄。 客戶端憑據

缺少標題

{
    "error_code": "400003",
    "message": "Missing header"
}

當IMS組織頭(x-gw-ims-org-id)在API請求中缺失。 在重試之前,請確保頭包含在IMS組織的ID中。

配置檔案無效

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

當用戶或Adobe I/O整合(由 訪問令牌Authorization 頭)無權撥打 Experience Platform 中提供的IMS組織的API x-gw-ims-org-id 標題。 在重試之前,請確保在頭中為IMS組織提供了正確的ID。 如果您不知道您的組織ID,可以在 Adobe I/O控制台:的 整合 頁籤,導航到 概述 的ID 客戶端憑據

刷新etag錯誤

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

如果其他API調用方對任何源實體或目標實體(如流、連接、源連接器或目標連接)進行了更改,則可能會收到etag錯誤。 由於版本不匹配,您嘗試進行的更改將不會應用於實體的最新版本。

要解決此問題,您需要再次獲取實體,確保更改與實體的新版本相容,然後將新etag放在 If-Match 頭,最後進行API調用。

未指定有效的內容類型

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

當POST、PUT或PATCH請求無效或丟失時,將顯示此錯誤消息 Content-Type 標題。 確保在請求中包含報頭,並且其值 application/json

用戶區域缺失

{
    "error_code": "403027",
    "message": "User region is missing"
}

以下兩種情況中的一種顯示此錯誤消息:

  • 當IMS組織頭不正確或格式錯誤時(x-gw-ims-org-id)。 再次嘗試之前,請確保包含IMS組織的正確ID。
  • 當您的帳戶(如所提供的身份驗證憑據所表示)未與產品配置檔案關聯以進行Experience Platform時。 按照上的步驟操作 生成訪問憑據 在平台API驗證教程中,將平台添加到您的帳戶並相應地更新您的驗證憑據。

服務疑難解答目錄

以下是故障排除指南和API參考文檔的清單 Experience Platform API。 每個故障排除指南都提供針對特定問題的常見問題和解決方案的答案 Platform 服務。 API參考文檔提供了每個服務的所有可用端點的全面指南,並顯示您可能接收的示例請求體、響應和錯誤代碼。

服務 API 參考 疑難排解
存取控制 訪問控制API 訪問控制故障排除指南
Adobe Experience Platform資料接收 Data Ingestion API 批量攝取故障排除指南

流攝入故障排除指南
Adobe Experience Platform資料科學工作區 Sensei Machine Learning API Data Science Workspace 故障排除指南
Adobe Experience Platform資料治理 Policy Service API
Adobe Experience Platform Identity Service Identity Service API Identity Service 故障排除指南
Adobe Experience Platform查詢服務 Query Service API Query Service 故障排除指南
Adobe Experience Platform分割 Segmentation API
Catalog Service Catalog Service API
Experience Data Model (XDM) Schema Registry API XDM System 常見問題解答和故障排除指南
Flow Service (Sources 和 Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile 故障排除指南
沙箱 沙盒API 沙箱故障排除指南

本頁內容