Managed Runtime API(托管运行时 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
标头中包含一个值为Bearer {{api_key}}
的 API 密钥。
要查找您的 API 密钥,请登录 Runtime Admin工具并转到帐户设置页面。
请将您的 API 密钥视为密码,因为它允许脚本代表您执行操作。
我们将通过一个简短教程向您展示如何使用 API,该教程基于一些格式化为 curl
命令的示例请求。
在运行命令之前,将所有占位符替换为实际值。占位符的格式如 {{placeholder}}
。
对于大多数请求,您必须将 {{project_id}}
替换为您的实际项目 ID。要查找您的项目 ID,请登录 Runtime Admin 工具并转到项目的设置页面。
项目 ID 最长可达 20 个字符,并且对于组织来说必须是唯一的。
使用环境
我们对 Managed Runtime API 的第一个请求列出了属于项目的所有环境(在 API 中也称为“目标”):
现在我们创建一个名为 staging
的环境,可以用于验证更改,然后将其部署到 production
:
要使用您的新环境,您必须在其中部署一个捆绑包。
我们来回顾所创建的 staging
环境的详细信息:
最后,我们来修改 staging
的代理配置:
更改配置会导致当前捆绑包自动重新部署,以便更改生效。
如果您在使用 API 时遇到问题,请尝试这些故障排除步骤。
- 将
--fail
参数添加到curl
命令中。 - 检查 API 密钥。
- 检查项目 ID。
API 端点也可以在浏览器中工作。登录到 Runtime Admin 工具,然后直接在浏览器中打开您正在使用的端点。
现在您已了解 API 的功能,甚至还发出了一些示例请求!要了解有关 API 的更多信息,请参阅 API Specification(API 规范)。