Experience Platform常見問題集和疑難排解指南
建立對象：
- 開發人員
本檔案提供有關Adobe Experience Platform常見問題的解答，以及任何Experience Platform API中可能遇到的常見錯誤的高層級疑難排解指南。 如需個別Experience Platform服務的疑難排解指南，請參閱下方的服務疑難排解目錄。
常見問題集
以下是有關Adobe Experience Platform常見問題的解答清單。
什麼是Experience Platform API？
Experience Platform提供多個使用HTTP要求存取Experience Platform資源的RESTful API。 這些服務API會分別公開多個端點，並允許您執行作業以列出(GET)、查詢(GET)、編輯(PUT和/或PATCH)及刪除(DELETE)資源。 如需每個服務可用的特定端點和作業的詳細資訊，請參閱Adobe I/O上的API參考檔案。
如何格式化API請求？
要求格式會依使用的Experience Platform API而有所不同。 要瞭解如何建構API呼叫，最好的方式是遵循檔案中針對您使用的特定Experience Platform服務提供的範例。
如需格式化API要求的詳細資訊，請造訪Experience Platform API快速入門手冊閱讀範例API呼叫區段。
什麼是我的組織？
組織是客戶的Adobe表示法。 任何授權的Adobe解決方案都會與此客戶組織整合。 當組織有權使用Experience Platform時，它可以指派存取權給開發人員。 組織ID (x-gw-ims-org-id)代表應為其執行API呼叫的組織，因此需要作為所有API要求中的標頭。 可以透過Adobe Developer Console找到此ID：在 整合 索引標籤中，瀏覽至 總覽 區段以進行任何特定整合，以在 使用者端認證 下找到此ID。 如需如何向Experience Platform進行驗證的逐步說明，請參閱驗證教學課程。
我可以在哪裡找到我的API金鑰？
API金鑰需作為所有API請求中的標頭。 您可透過Adobe Developer Console找到它。 在主控台的 整合 標籤上，瀏覽至 總覽 區段以取得特定的整合，您會在 使用者端認證 下找到金鑰。 如需如何驗證Experience Platform的逐步解說，請參閱驗證教學課程。
如何取得存取Token？
所有API呼叫的Authorization標頭中都需要存取權杖。 只要您擁有組織整合的存取權，便可使用CURL指令產生這些專案。 存取權杖僅有效24小時，之後必須產生新權杖才能繼續使用API。 如需有關產生存取權杖的詳細資訊，請參閱驗證教學課程。
如何使用查詢引數？
某些Experience Platform API端點會接受查詢引數，以找出特定資訊並篩選回應中傳回的結果。 查詢引數會以問號(?)符號附加至要求路徑，後面接著一或多個查詢引數（使用格式paramName=paramValue）。 在單一呼叫中組合多個引數時，您必須使用&符號(&)來分隔個別引數。 下列範例示範使用多個查詢引數的請求在檔案中如何呈現。
常用的查詢引數範例包括：
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created
如需特定服務或端點可使用哪些查詢引數的詳細資訊，請參閱服務特定檔案。
如何在PATCH請求中指定要更新的JSON欄位？
Experience Platform API中的許多PATCH作業都會使用JSON指標字串來指示要更新的JSON屬性。 這些通常包含在使用JSON修補程式格式的要求裝載中。 如需這些技術所需語法的詳細資訊，請參閱API基礎指南。
我可以使用Postman來呼叫Experience Platform API嗎？
Postman是視覺化呼叫RESTful API的實用工具。 Experience Platform API快速入門手冊包含匯入Postman集合的影片和指示。 此外，也提供每項服務的Postman集合清單。
Experience Platform的系統需求為何？
根據您使用的是UI還是API，以下系統需求適用：
針對以UI為基礎的作業：
- 現代的標準網路瀏覽器。 雖然建議使用最新版Chrome，但亦支援Firefox、Internet Explorer和Safari的最新和舊版主要版本。
- 每次發行新的主要版本時，Experience Platform會開始支援最新版本，而不再支援第三個最新版本。
- 所有瀏覽器都必須啟用Cookie和JavaScript。
對於API和開發人員互動：
- 要為REST、串流和Webhook整合開發的開發環境。
錯誤與疑難排解
以下是您使用任何Experience Platform服務時可能遇到的錯誤清單。 如需個別Experience Platform服務的疑難排解指南，請參閱下方的服務疑難排解目錄。
API狀態代碼
在任何Experience Platform API上可能會遇到下列狀態代碼。 每種原因有多種多樣，因此本節中提供的說明本質上是一般性解釋。 如需個別Experience Platform服務中特定錯誤的詳細資訊，請參閱下方的服務疑難排解目錄。
發生此錯誤的可能原因是，您可能沒有存取或編輯資源所需的存取控制許可權。 閱讀如何取得必要的屬性型存取控制許可權，以使用Experience Platform API。
請求標頭錯誤
Experience Platform中的所有API呼叫都需要特定的要求標頭。 若要檢視個別服務所需的標頭，請參閱API參考檔案。 若要尋找所需驗證標頭的值，請參閱驗證教學課程。 如果在進行API呼叫時，缺少這些標頭中的任何一個或這些標頭無效，便可能會發生以下錯誤。
缺少OAuth權杖
{
"error_code": "403010",
"message": "Oauth token is missing."
}
當API請求中缺少Authorization標頭時，會顯示此錯誤訊息。 在重試之前，請確定Authorization標頭包含於有效的存取權杖中。
OAuth權杖無效
{
"error_code": "401013",
"message": "Oauth token is not valid"
}
當Authorization標頭中提供的存取權杖無效時，此錯誤訊息便會顯示。 請確定已正確輸入權杖，或在Adobe I/O主控台中產生新權杖。
需要API金鑰
{
"error_code": "403000",
"message": "Api Key is required"
}
當API要求中缺少API金鑰標頭(x-api-key)時，此錯誤訊息便會顯示。 在重試之前，請確定標頭包含有效的API金鑰。
API金鑰無效
{
"error_code": "403003",
"message": "Api Key is invalid"
}
當提供的API金鑰標頭(x-api-key)的值無效時，會顯示此錯誤訊息。 在重試之前，請確定您已正確輸入金鑰。 如果您不知道您的API金鑰，可以在Adobe I/O主控台中找到：在 整合 索引標籤中，瀏覽至 總覽 區段以取得特定整合，以便在 使用者端認證 下找到API金鑰。
標頭遺失
{
"error_code": "400003",
"message": "Missing header"
}
當API請求中缺少組織標頭(x-gw-ims-org-id)時，會顯示此錯誤訊息。 在重試之前，請確定您的組織ID中包含標頭。
設定檔無效
{
"error_code": "403025",
"message": "Profile is not valid"
}
當使用者或Adobe I/O整合（由Authorization標頭中的存取權杖識別）無權呼叫x-gw-ims-org-id標頭中提供的組織的Experience Platform API時，此錯誤訊息便會顯示。 在重試之前，請確定已在標頭中為您的組織提供正確的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"
}
此錯誤訊息會在以下兩種情況之一中顯示：
- 在API要求中傳遞不正確或格式錯誤的組織ID標頭(
x-gw-ims-org-id)時。 在重試之前，請確定已包含您組織的正確ID。 - 當您的帳戶（由提供的驗證憑證表示）未與Experience Platform的產品設定檔建立關聯時。 依照Experience Platform API驗證教學課程中產生存取認證上的步驟操作，將Experience Platform新增至您的帳戶並相應地更新您的驗證認證。
服務疑難排解目錄
以下是Experience Platform API的疑難排解指南和API參考檔案清單。 每個疑難排解指南都會提供常見問題的解答，以及個別Experience Platform服務特定問題的解決方案。 API參考檔案提供每個服務所有可用端點的完整指南，並顯示您可能收到的範例要求內文、回應和錯誤代碼。