環境変数を使用した保護リソースへのアクセス

Composable-doc-translations-July-2024 Managed Runtime 環境変数を使用すると、コードを変更することなく、環境で実行されているアプリケーションプロセスに変数を追加できます。環境変数は安全に保存され、次のようなユースケースに最適です。

API キーで保護されているサードパーティーのリソースを呼び出す
React.js レンダリングを条件付きで変更する

詳細については、環境変数を参照してください。

環境変数を使用して、安全な外部リソースにアクセスするために使用される API キーを保存しましょう。このチュートリアルでは、架空のサードパーティコンテンツ管理システム (CMS) をリソースとして使用します。ssr.js で、CMS にリクエストを行い、保護されたデータで応答するハンドラーを Express.js サーバーに追加します。次に、このハンドラーを呼び出してデータにアクセスします。

セキュリティ上の理由から、API キーはクライアント側のコードではなく、サーバー側のコードから CMS を呼び出します。

このチュートリアルを完了するには、まず次の要件を満たす必要があります。

Managed Runtime と Runtime Admin にアクセスできること。Managed Runtime の管理を参照してください。
Managed Runtime API を使用するための API キーをもっていること。API キーを見つけるには、Runtime Admin ツールにログインし、Account Settings (アカウント設定) ページを開きます。
環境変数を設定するプロジェクトに対するデベロッパーまたは管理者の役割をもっていること。アクセス権がない場合は、Managed Runtime 管理者役割をもつユーザーにヘルプを依頼してください。

このチュートリアルのコマンドを実行する前に、プレースホルダーを実際の値に置き換えてください。プレースホルダーは $PLACEHOLDER の形式になっています。

現在のセッションで環境変数を設定するには、ターミナルを開き、次のコマンドを実行します。
- Windows: set CMS_API_KEY='my-cms-api-key'
- macOS を含むほとんどの Unix 系オペレーティングシステム: export CMS_API_KEY='my-cms-api-key'
次のコマンドを実行して、環境変数が正しく設定されているかどうかを確認します。
- Windows: echo %CMS_API_KEY%
- macOS を含むほとんどの Unix 系オペレーティングシステム: echo $CMS_API_KEY
このコマンドで返される出力は my-cms-api-key です。
ssr.js で CMS を呼び出すために、次の JavaScript コードを追加します。

ハンドラーを Express.js サーバーのルートにバインドします。次に、npm start を使用して開発サーバーを起動します。最後に、ハンドラーにローカルで移動して、CMS データが返されることを確認します。

変更を本番環境にデプロイする前に、これらの手順を非本番環境でテストすることをお勧めします。

projects_target_env_var_partial_update エンドポイントを呼び出して、環境変数を設定します。これにより、バンドルがデプロイされます。コードで API キーを使用する前に、環境が再デプロイされるのを待ちます。また、Runtime Admin を使用して環境変数を管理することもできます。環境変数を参照してください。

ローカルマシンから目的の環境にバンドルをデプロイします。