使用環境變數存取受保護的資源

Managed Runtime 環境變數可讓您將變數新增至在某個環境中執行的應用程式程序當中,而無需變更程式碼。環境變數能安全儲存,是下列使用案例的理想選擇:

  • 呼叫受 API 金鑰保護的第三方資源
  • 有條件地改變 React.js 轉譯

如需更多詳細資料,請參閱環境變數

讓我們使用環境變數,來儲存用於存取安全外部資源的 API 金鑰。在本教學中,資源是一個假想的第三方內容管理系統 (CMS)。我們將在 ssr.js 中為 Express.js 伺服器新增一個處理常式,以向 CMS 發出要求,並使用受保護的資料進行回應。然後,我們會呼叫處理常式來存取資料。

基於安全考量,API 金鑰會從伺服器端程式碼 (而不是用戶端程式碼) 呼叫 CMS。

要完成本教學,請首先:

  • 獲得 Managed Runtime 和 Runtime Admin 的存取權。請參閱 Managed Runtime 管理
  • 擁有 API 金鑰以使用 Managed Runtime API。若要尋找您的 API 金鑰,請登入 Runtime Admin 工具,並前往 Account Settings (帳戶設定) 頁面。
  • 在您要為其設定環境變數的專案中,擁有開發人員或管理員角色。如果您沒有存取權限,請要求具有 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. 新增此 JavaScript 程式碼,以在 ssr.js 中呼叫 CMS:

  1. 將處理常式綁定到 Express.js 伺服器中的路由。接下來,使用 npm start 啟動開發伺服器。最後,前往本機處理常式,驗證是否傳回 CMS 資料。

建議在非 Production 環境中測試這些步驟,然後再將變更部署到生產 Production 環境。

在執行本教學的命令之前,請以實際值取代預留位置。預留位置的格式為:$PLACEHOLDER

  1. 呼叫 projects_target_env_var_partial_update 端點來設定環境變數。這將部署您的套件。等待環境重新部署,然後再在程式碼中使用 API 金鑰。您還可以使用 Runtime Admin 來管理環境變數。請參閱環境變數
  1. 將套件從本機電腦部署到您選擇的環境。