使用环境变量访问受保护的资源

Managed Runtime 环境变量允许您将变量添加到环境中运行的应用程序进程,而无需更改代码。环境变量被安全存储,使其非常适合以下用例:

  • 调用受 API 密钥保护的第三方资源
  • 有条件地更改 React.js 渲染

有关详细信息,请参阅环境变量

让我们使用环境变量来存储用于访问安全外部资源的 API 密钥。在本教程中,资源是一个假想的第三方内容管理系统 (CMS)。我们将向 ssr.js 中的 Express.js 服务器添加一个处理程序,该处理程序向 CMS 发出请求并使用受保护的数据进行响应。然后,我们通过调用处理程序来访问数据。

出于安全原因,API 密钥从服务器端代码(而不是客户端代码)调用 CMS。

要完成本教程,首先:

  • 获取对 Managed Runtime 和 Runtime Admin 的访问权限。请参阅 Managed Runtime 管理
  • 拥有使用 Managed Runtime API 的 API 密钥。要查找您的 API 密钥,请登录 Runtime Admin 工具并转到帐户设置页面。
  • 在要为其设置环境变量的项目中具有开发人员或管理员角色。如果您没有访问权限,请具有 Managed Runtime 管理员角色的人员为您提供帮助。

在运行本教程中的命令之前,请将所有占位符替换为实际值。占位符的格式如 $PLACEHOLDER

  1. 要在当前会话中设置环境变量,请打开终端并运行以下命令:

    • Windows: set CMS_API_KEY='my-cms-api-key'
    • 大多数类 Unix 操作系统,包括 macOS: export CMS_API_KEY='my-cms-api-key'
  2. 通过运行以下命令检查环境变量是否设置正确:

    • Windows: echo %CMS_API_KEY%
    • 大多数类 Unix 操作系统,包括 macOS: echo $CMS_API_KEY

    该命令返回以下输出:my-cms-api-key

  3. 在以下位置添加此用于在 ssr.js 中调用 CMS 的 JavaScript 代码:

  1. 将处理程序绑定到 Express.js 服务器中的路由。接下来,使用 npm start 启动开发服务器。最后,导航到本地处理程序以验证是否返回 CMS 数据。

建议在非生产环境中测试这些步骤,然后再将更改部署到生产环境。

在运行本教程中的命令之前,请将所有占位符替换为实际值。占位符的格式如 $PLACEHOLDER

  1. 调用 projects_target_env_var_partial_update 端点以设置环境变量。这将部署您的捆绑包。等待环境重新部署,然后再在您的代码中使用 API 密钥。您还可以使用 Runtime Admin 来管理环境变量。请参阅环境变量
  1. 将捆绑包从本地计算机部署到所选环境。