AWS 合作夥伴中心 API 參考已重組。如需支援的 API 操作的詳細資訊，請參閱 AWS 合作夥伴中心 API 參考。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用利益應用程式

利益應用程式會為合作夥伴對特定利益的請求建立模型。它會擷取根據利益特定條件評估和處理請求所需的所有資訊。利益應用程式生命週期會經歷多種狀態，從建立草稿到最終核准或拒絕。

建立利益應用程式

合作夥伴使用 CreateBenefitApplication API 動作建立利益應用程式，以啟動利益請求程序。建立時，應用程式會進入 PENDING_SUBMISSION 狀態，讓合作夥伴在提交審核之前準備完整的資訊。

建立利益應用程式時，合作夥伴必須提供：

合作夥伴可以選擇性地提供：

CreateBenefitApplication API 會執行軟驗證，只檢查基本欄位類型和模式。完整商業邏輯驗證會在提交期間進行，允許合作夥伴儲存不完整的應用程式，並在稍後傳回以完成它們。

最佳實務：合作夥伴應使用來自 的利益請求結構描述GetBenefit，確切了解在建立應用程式之前需要哪些資訊。這可降低因資料遺失或無效而提交失敗的可能性。

更新利益應用程式

合作夥伴可以使用 UpdateBenefitApplication API 動作修改草稿利益應用程式。這可讓合作夥伴在提交之前精簡資訊、新增文件或更正錯誤。

更新利益應用程式時，合作夥伴必須提供：

合作夥伴必須提交完整的利益應用程式物件，即使只有特定欄位正在變更。最佳實務是先使用 擷取最新的應用程式詳細資訊GetBenefitApplication、修改必要欄位，然後將完整更新的承載提交至 UpdateBenefitApplication。

樂觀鎖定：修訂欄位可確保只有在應用程式自上次擷取以來未變更時，才會套用更新。如果修訂版不符合目前的資料庫值，則更新會因衝突錯誤而遭到拒絕。這可防止合作夥伴意外覆寫其他程序或系統所做的變更。

更新只能在應用程式處於 PENDING_SUBMISSION 狀態時執行。提交後，應用程式會進入檢閱程序，且無法再透過此 API 更新。

將資源與利益應用程式建立關聯

合作夥伴可以使用 AssociateBenefitApplicationResource API 動作將受益應用程式連結至相關資源。這會在利益與使用利益的業務內容之間建立寶貴的關聯。

支援的資源類型包含：

資源關聯只能在提交之前發生。提交利益應用程式後 （狀態變更為 IN_REVIEW)，即不允許進一步關聯。合作夥伴最多可將 10 個資源與每個利益應用程式建立關聯。

若要取消資源的關聯，合作夥伴會使用 DisassociateBenefitApplicationResource API 動作。與關聯類似，取消關聯只能以 PENDING_SUBMISSION 狀態發生。

提交利益應用程式

當利益應用程式完成並準備好AWS檢閱時，合作夥伴會使用 SubmitBenefitApplication API 動作提交它。提交會觸發從 PENDING_SUBMISSION 到 的狀態轉換，IN_REVIEW並啟動利益特定的核准工作流程。

提交時，API 會執行全面的驗證，包括：

如果驗證失敗，API 會傳回 ValidationException，其中包含詳細的錯誤代碼和訊息，指出哪些欄位需要更正。合作夥伴必須使用 解決這些問題，UpdateBenefitApplication然後再嘗試再次提交。

檔案處理需求：如果任何連接的檔案仍處於 PENDING 狀態，則無法提交利益應用程式。合作夥伴必須等待檔案處理完成 （狀態變更為 SUCCEEDED)，才能提交。如果檔案處理失敗 （狀態 FAILED)，合作夥伴應該上傳更正的版本。

成功提交後：

合作夥伴可以透過擷取應用程式並監控階段欄位來追蹤提交進度，該欄位指出目前的核准階段 （例如「商業核准」、「技術核准」、「財務核准」)。

管理提交的應用程式

提交後，合作夥伴在管理利益應用程式方面的選項有限，但 API 為常見案例提供特定動作。

回收利益應用程式

如果合作夥伴在提交後發現錯誤或需要進行變更，他們可以使用 RecallBenefitApplication API 動作叫用應用程式。Recall 會將應用程式轉換回 PENDING_SUBMISSION 狀態，允許更新和重新提交。

召回應用程式時，合作夥伴應該提供：

原因欄位可實現更好的可追蹤性，並有助於AWS了解導致召回的常見問題，以通知未來改善利益應用程式程序。

取回後，合作夥伴可以使用 UpdateBenefitApplication進行必要的變更，然後在準備就緒SubmitBenefitApplication時使用 重新提交。

修改利益應用程式

對於提交後的次要更正，合作夥伴可以使用 AmendBenefitApplication API 動作來更新特定欄位，而不會叫用整個應用程式。當AWS檢閱者在檢閱過程中請求釐清或更正時，此功能特別有用。

修訂使用合作夥伴指定的 JSON 修補程式樣式方法：

合作夥伴可以在單一 API 呼叫中提交最多 10 個修訂。每個修訂都必須包含更新的修訂編號，才能進行樂觀鎖定。

修訂應用於次要更正。對於重大變更，合作夥伴應該使用 RecallBenefitApplication 將應用程式傳回至草稿狀態，以進行全面更新。

取消利益應用程式

如果合作夥伴不再需要利益或希望撤銷其應用程式，他們可以使用 CancelBenefitApplication API 動作取消它。取消會將應用程式轉換為CANCELED狀態，永久結束應用程式程序。

取消應用程式時，合作夥伴應提供：

一旦取消，應用程式就無法重新啟用。如果合作夥伴稍後決定他們需要利益，他們必須建立新的利益應用程式。

取消的常見原因包括：

檢視利益應用程式詳細資訊

合作夥伴可以使用 GetBenefitApplication API 動作擷取有關利益應用程式的完整資訊。這可提供應用程式的完整檢視，包括：

應用程式中繼資料：

狀態資訊：

應用程式內容：

稽核資訊：

當應用程式處於 ACTION_REQUIRED 狀態時，狀態原因代碼特別重要。這些代碼針對合作夥伴需要處理的應用程式以繼續，提供具體、可行的指引。

列出利益應用程式

合作夥伴可以使用 ListBenefitApplications API 動作檢視其所有利益應用程式。這會傳回具有強大篩選功能的應用程式摘要分頁清單。

合作夥伴可以依下列條件篩選應用程式：

清單回應包含基本摘要資訊，例如：

合作夥伴可以使用排序參數設定結果排序，並可選擇依建立日期、狀態、程式或利益識別符以遞增或遞減順序排序。

Dashboard Building：ListBenefitApplicationsAPI 旨在支援合作夥伴儀表板建立。透過篩選和排序應用程式，合作夥伴可以建立檢視，例如：