Platform 常見問答集與疑難排解指南

本檔案提供有關Adobe Experience Platform常見問題的解答，以及高階疑難排解指南，說明在任何Experience Platform API中可能遇到的常見錯誤。 有關各個Platform服務的故障排除指南，請參見下面的服務故障排除目錄。

常見問題集

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

什麼是Experience Platform API?

Experience Platform 提供多個使用HTTP請求來存取資源的REST風格 Platform API。這些服務API每個都會顯示多個端點，並允許您執行列出(GET)、查閱(GET)、編輯(PUT和／或PATCH)和刪除(DELETE)資源的操作。 有關每項服務可用的特定端點和操作的詳細資訊，請參閱API參考文檔中的Adobe I/O。

如何設定API要求的格式？

請求格式會依使用的Platform API而異。 瞭解如何建構API呼叫的最佳方式，是依循您所使用之特定Platform服務的說明檔案中提供的範例。

如需有關建立API要求的詳細資訊，請造訪平台API快速入門手冊閱讀範例API呼叫一節。

我的IMS組織是什麼？

IMS組織是客戶的Adobe表示。 任何授權的Adobe解決方案皆與此客戶組織整合。 當IMS組織有權使用Experience Platform時，它可指派存取權給開發人員。 IMS組織ID(x-gw-ims-org-id)代表應執行API呼叫的組織，因此在所有API請求中都是必要的標題。 此ID可透過Adobe開發人員主控台找到：在​Integrations​標籤中，導覽至​Overview​區段以取得任何特定整合，以在​Client Credentials​下尋找ID。 有關如何驗證到Platform的逐步說明，請參見驗證教程。

我可以在哪裡找到API金鑰？

所有API請求中都需要API金鑰作為標題。 您可透過Adobe開發人員主控台找到。 在控制台內，在​Integrations​標籤上，導覽至​Overview​區段以取得特定整合，您將在​Client Credentials​下找到金鑰。 有關如何驗證到Platform的逐步說明，請參見驗證教程。

我要如何取得存取Token?

所有API呼叫的「授權」標題中都需要存取Token。 只要您擁有IMS組織整合的存取權，就可使用curl命令產生。 存取Token僅有24小時有效，之後必須產生新Token才能繼續使用API。 有關生成訪問Token的詳細資訊，請參閱驗證教程。

如何使用查詢參數？

有些Platform API端點會接受查詢參數，以找出特定資訊並篩選回應中傳回的結果。 查詢參數會附加至具有問號(?)符號的請求路徑，後面接著使用格式paramName=paramValue的一或多個查詢參數。 在單一呼叫中結合多個參數時，您必須使用&符號(&)來分隔個別參數。 下列範例說明如何使用多個查詢參數的請求在檔案中呈現。

常用查詢參數的範例包括：

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

有關特定服務或端點可使用哪些查詢參數的詳細資訊，請參閱特定服務的文檔。

如何在PATCH請求中指定要更新的JSON欄位？

Platform API中的許多PATCH操作使用JSON Pointer字串來指示要更新的JSON屬性。 這些通常包含在使用JSON Patch格式的請求負載中。 如需這些技術所需語法的詳細資訊，請參閱API基礎指南。

我可以使用Postman呼叫Platform API嗎？

Postmanis 是可視化對REST風格的API呼叫的實用工具。平台API快速入門手冊包含視訊和匯入Postman系列的指示。 此外，還提供每個服務的郵遞員收集清單。

Platform的系統需求為何？

視您使用的是UI或API而定，會套用下列系統需求：

對於基於UI的操作：

• 現代化、標準的網頁瀏覽器。 雖然建議使用最新版Chrome，但也支援目前和舊版的Firefox、Internet Explorer和Safari。
  • 每次發行新的主版本時，Platform會開始支援最新版本，而放棄支援第三個最新版本。
• 所有瀏覽器都必須啟用Cookie和JavaScript。

針對API和開發人員互動：

• 針對REST、串流和Webhook整合進行開發的開發環境。

錯誤和疑難排解

以下是使用任何Experience Platform服務時可能遇到的錯誤清單。 有關各個Platform服務的故障排除指南，請參見下面的服務故障排除目錄。

API狀態代碼

在任何Experience Platform API上都可能遇到以下狀態代碼。 每個原因都有各種原因，因此本節中的解釋是一般性的。 有關個別Platform服務中特定錯誤的詳細資訊，請參閱以下服務疑難排解目錄。

請求標題錯誤

Platform中的所有API呼叫都需要特定的請求標題。 若要瞭解個別服務需要哪些標題，請參閱API參考檔案。 要查找所需驗證標題的值，請參閱驗證教程。 如果在進行API呼叫時這些標題中有任何遺失或無效，可能會發生下列錯誤。

OAuth Token遺失

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

當API請求中缺少Authorization標題時，會顯示此錯誤訊息。 在再次嘗試之前，請確定授權標題已包含有效的存取Token。

OAuth Token無效

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

當Authorization標題中提供的存取Token無效時，會顯示此錯誤訊息。 請確定Token已正確輸入，或在Adobe I/O主控台中產生新Token。

需要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控制台中找到：在​Integrations​標籤中，導覽至​Overview​區段以取得特定整合，以在​Client Credentials​下尋找API金鑰。

遺失標題

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

當API請求中遺失IMS組織標題(x-gw-ims-org-id)時，會顯示此錯誤訊息。 請確定標題已包含在您IMS組織的ID中，然後再試一次。

描述檔無效

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

當使用者或Adobe I/O整合（由Authorization標題中的存取Token識別）無權呼叫Experience Platform API（用於x-gw-ims-org-id標題中提供的IMS組織）時，會顯示此錯誤訊息。 請確定您已在頁首中為您的IMS組織提供正確的ID，然後再次嘗試。 如果您不知道您的組織ID，可在Adobe I/O控制台中找到：在​Integrations​標籤中，導覽至​Overview​區段以取得特定整合，以在​Client Credentials​下尋找ID。

未指定有效的內容類型

{
    "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"
}

當您的帳戶（由提供的驗證憑證所代表）未與產品設定檔建立關聯以進行Experience Platform時，會顯示此錯誤訊息。 遵循平台API驗證教學課程中產生存取認證的步驟，將平台新增至您的帳戶並相應更新驗證認證。

服務疑難排解目錄

以下是Experience Platform API的疑難排解指南和API參考檔案清單。 每個疑難排解指南都提供有關個別Platform服務所特有問題的常見問答和解決方案。 API參考檔案提供每個服務所有可用端點的完整指南，並顯示您可能收到的範例要求主體、回應和錯誤碼。