Managed Runtime API

使用 Managed Runtime API，即可控制部署至 Commerce Cloud 的 Managed Runtime 上的應用程式。您可建立與 Runtime Admin 網路應用程式具有相同功能的自訂工具，但還能獲得更多管理功能及設定選項。

Managed Runtime API 僅限用於管理目的。請不要在網店程式碼中向此 API 發出要求。

這份指南假設您已經十分熟悉 Managed Runtime 及相關概念，例如：專案、環境、套件和部署等。如需進一步瞭解，請參閱 Managed Runtime 概觀。

Mobify 品牌名稱仍會出現在 Managed Runtime API 基底 URL 的 mobify.com 網域中。雖然新的 Salesforce 網域最終將會取代 Mobify 網域，不過對於 Mobify 網域的支援仍會持續。

若要提出 API 要求，您必須在 HTTP 要求 Authorization 標頭中包含 API 金鑰和此值 Bearer {{api_key}}。

若要尋找您的 API 金鑰，請登入 Runtime Admin 工具，並前往 Account Settings (帳戶設定) 頁面。

請將您的 API 金鑰視為密碼，因為這能代表您允許指令碼執行操作。

我們將根據一些範例要求進行簡短的教學，為您示範如何使用 API，範例要求的格式為 curl 命令。

在執行命令前，請以實際值取代預留位置。預留位置的格式為：{{placeholder}}

在大部分要求中，您必須以實際專案 ID 取代 {{project_id}}。若要查詢您的專案 ID，請登入 Runtime Admin 工具，並前往專案的設定頁面。

專案 ID 最長可為 20 個字元，且必須專屬組織獨有。

我們對 Managed Runtime API 的第一個要求列出了屬於某專案的所有環境 (在 API 中稱之為「目標」)：

現在，讓我們建立一個名為 staging 的環境，好讓我們在將變更部署到 production 之前，使用它來驗證變更：

若要使用新的環境，您必須部署套件至該環境。

讓我們檢查一下我們建立的 staging 環境的詳細資料：

最後，來修改 staging 的 Proxy 設定：

變更設定將會導致目前套件自動重新部署，以讓變更生效。

若您在使用 API 時遇到問題，請嘗試這些疑難排解步驟。

API 端點在瀏覽器中也能使用。登入 Runtime Admin 工具，並在您的瀏覽器中直接開啟正在使用的端點。

現在您已經熟悉 API 的功能，甚至能做出某些範本要求了！如要進一步瞭解 API，請參考 API 規格。