Platform 常見問題集和疑難排解指南
本檔案提供有關Adobe Experience Platform常見問題的解答,以及任何情況下可能遇到的常見錯誤的詳盡疑難排解指南 Experience Platform API。 針對個別使用者提供疑難排解指南 Platform 服務,請參閱 服務疑難排解目錄 底下。
常見問題集 faq
以下是有關Adobe Experience Platform常見問題的解答清單。
什麼是 Experience Platform API? what-are-experience-platform-apis
Experience Platform 提供多個使用HTTP請求存取的RESTful API Platform 資源。 這些服務API會分別公開多個端點,並允許您執行操作以列出(GET)、查詢(GET)、編輯(PUT和/或PATCH)以及刪除(DELETE)資源。 如需每個服務可用的特定端點和作業的詳細資訊,請參閱 API參考檔案 在Adobe I/O上。
如何格式化API請求? how-do-i-format-an-api-request
請求格式會因 Platform 正在使用的API。 要瞭解如何架構API呼叫,最好的方式是遵循檔案中針對特定用途提供的範例 Platform 您正在使用的服務。
如需格式API請求的詳細資訊,請造訪Platform API快速入門手冊 讀取範例API呼叫 區段。
什麼是我的組織? what-is-my-ims-organization
組織是客戶的Adobe表示法。 任何授權的Adobe解決方案都會與此客戶組織整合。 當組織有權使用 Experience Platform,然後它會指派存取權給開發人員。 組織ID (x-gw-ims-org-id
)代表應為其執行API呼叫的組織,因此是所有API要求中的標頭。 此ID可透過 Adobe Developer Console:在 整合 標籤,導覽至 概觀 區段以取得下方的ID 使用者端認證. 如需如何在中驗證身分的逐步解說 Platform,請參閱 驗證教學課程.
我可以在哪裡找到我的API金鑰? where-can-i-find-my-api-key
API金鑰需作為所有API請求中的標頭。 您可透過 Adobe Developer Console. 在主控台的 整合 標籤,導覽至 概觀 區段中的特定整合,您將會在下方找到索引鍵 使用者端認證. 如需如何驗證的逐步解說,請參閱 Platform,請參閱 驗證教學課程.
如何取得存取Token? how-do-i-get-an-access-token
所有API呼叫的Authorization標頭中都需要存取權杖。 只要您擁有組織整合的存取權,便可使用CURL指令產生這些專案。 存取權杖僅有效24小時,之後必須產生新權杖才能繼續使用API。 如需有關產生存取權杖的詳細資訊,請參閱 驗證教學課程.
如何使用查詢引數? how-do-i-user-query-parameters
部分 Platform API端點接受查詢引數以找出特定資訊,並篩選回應中傳回的結果。 查詢引數會附加至帶有問號(?
)符號,接著一個或多個使用格式的查詢引數 paramName=paramValue
. 在單一呼叫中組合多個引數時,您必須使用&符號(&
)以分隔個別引數。 下列範例示範使用多個查詢引數的請求在檔案中如何呈現。
常用的查詢引數範例包括:
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
如需特定服務或端點可使用哪些查詢引數的詳細資訊,請參閱服務特定檔案。
如何在PATCH請求中指定要更新的JSON欄位? how-do-i-indicate-a-json-field-to-update-in-a-patch-request
中的許多PATCH作業 Platform API使用 JSON指標 字串來指示要更新的JSON屬性。 這些通常包含在請求裝載中,使用 JSON修補程式 格式。 請參閱 API基礎指南 這些技術所需語法的詳細資訊。
我可以使用Postman來呼叫 Platform API? how-do-i-use-postman-to-make-calls-to-platform-apis
Postman 是將RESTful API呼叫視覺化的實用工具。 此 Platform API快速入門手冊 包含有關匯入Postman集合的影片和指示。 此外,也提供每項服務的Postman集合清單。
下列專案的系統需求為何 Platform? what-are-the-system-requirements-for-platform
根據您使用的是UI還是API,以下系統需求適用:
對於以UI為基礎的作業:
- 現代的標準網路瀏覽器。 而最新版本的 Chrome 建議使用,以及目前和先前的主要版本 Firefox, Internet Explorer也支援、和Safari。
- 每次發行新的主要版本時, Platform 開始支援最新版本,而不再支援第三個最新版本。
- 所有瀏覽器都必須啟用Cookie和JavaScript。
對於API和開發人員互動:
- 要為REST、串流和Webhook整合開發的開發環境。
錯誤與疑難排解 errors-and-troubleshooting
以下清單列出您在使用任何 Experience Platform 服務。 針對個別使用者提供疑難排解指南 Platform 服務,請參閱 服務疑難排解目錄 底下。
API狀態代碼 api-status-codes
下列狀態代碼可能出現在任何 Experience Platform API。 每種原因有多種多樣,因此本節中提供的說明本質上是一般性解釋。 有關個別特定錯誤的更多詳細資料 Platform 服務,請參閱 服務疑難排解目錄 底下。
請求標頭錯誤 request-header-errors
中的所有API呼叫 Platform 需要特定的請求標頭。 若要檢視個別服務所需的標頭,請參閱 API參考檔案. 若要尋找所需驗證標題的值,請參閱 驗證教學課程. 如果在進行API呼叫時,缺少這些標頭中的任何一個或這些標頭無效,便可能會發生以下錯誤。
缺少OAuth權杖 oauth-token-is-missing
{
"error_code": "403010",
"message": "Oauth token is missing."
}
此錯誤訊息會在以下情況顯示: Authorization
API請求中缺少標頭。 在重試之前,請確定Authorization標頭包含於有效的存取權杖中。
OAuth權杖無效 oauth-token-is-not-valid
{
"error_code": "401013",
"message": "Oauth token is not valid"
}
當提供的存取權杖位於 Authorization
標頭無效。 請確定已正確輸入權杖,或 產生新權杖 在Adobe I/O主控台中。
需要API金鑰 api-key-is-required
{
"error_code": "403000",
"message": "Api Key is required"
}
當API金鑰標頭(x-api-key
)中遺失。 在重試之前,請確定標頭包含有效的API金鑰。
API金鑰無效 api-key-is-invalid
{
"error_code": "403003",
"message": "Api Key is invalid"
}
當提供的API金鑰標頭的值(x-api-key
)無效。 在重試之前,請確定您已正確輸入金鑰。 如果您不知道您的API金鑰,可以在 Adobe I/O主控台:在 整合 標籤,導覽至 概觀 區段以找出底下的API金鑰 使用者端認證.
缺少標頭 missing-header
{
"error_code": "400003",
"message": "Missing header"
}
當組織標頭(x-gw-ims-org-id
)中遺失。 在重試之前,請確定您的組織ID中包含標頭。
設定檔無效 profile-is-not-valid
{
"error_code": "403025",
"message": "Profile is not valid"
}
當使用者或Adobe I/O整合(由以下識別 存取權杖 在 Authorization
標頭)無權呼叫 Experience Platform 中提供的組織API x-gw-ims-org-id
標頭。 在重試之前,請確定已在標頭中為您的組織提供正確的ID。 如果您不知道組織ID,可以在 Adobe I/O主控台:在 整合 標籤,導覽至 概觀 區段以找出下方的ID 使用者端認證.
重新整理etag錯誤 refresh-etag-error
{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}
如果其他API呼叫者對任何來源或目的地實體(例如流量、連線、來源聯結器或目標連線)進行了變更,您可能會收到etag錯誤。 由於版本不符,您嘗試進行的變更將不會套用至實體的最新版本。
若要解決此問題,您必須再次擷取實體,確保變更與實體的新版本相容,然後將新標籤放入 If-Match
標題,最後進行API呼叫。
未指定有效的內容型別 valid-content-type-not-specified
{
"type": "/placeholder/type/uri",
"status": 400,
"title": "BadRequestError",
"detail": "A valid content-type must be specified"
}
當POST、PUT或PATCH請求無效或遺失時,此錯誤訊息便會顯示 Content-Type
標頭。 確認要求中包含標頭,且其值為 application/json
.
缺少使用者區域 user-region-is-missing
{
"error_code": "403027",
"message": "User region is missing"
}
此錯誤訊息會在以下兩種情況之一中顯示:
- 當組織ID標頭不正確或格式錯誤時(
x-gw-ims-org-id
)會在API要求中傳遞。 在重試之前,請確定已包含您組織的正確ID。 - 當您的帳戶(由提供的驗證憑證表示)未與用於Experience Platform的產品設定檔建立關聯時。 請依照以下步驟操作: 產生存取認證 在Platform API驗證教學課程中,將Platform新增至您的帳戶並相應地更新驗證認證。
服務疑難排解目錄 service-troubleshooting-directory
以下為的疑難排解指南和API參考檔案清單 Experience Platform API。 每個疑難排解指南都會提供常見問題的解答,以及個別問題的解決方案 Platform 服務。 API參考檔案提供每個服務所有可用端點的完整指南,並顯示您可能收到的範例要求內文、回應和錯誤代碼。