Managed Runtime API

Managed Runtime API を使用して、Commerce Cloud の Managed Runtime にデプロイされたアプリケーションをコントロールします。Runtime Admin Web アプリケーションと同じ機能をもち、より多くの管理機能と構成オプションを利用するためのカスタムツールを作成できます。

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 ツールにログインし、Account Settings (アカウント設定) ページを開きます。

API キーを使用すると、スクリプトで操作を実行することができます。このため、API キーはパスワードと同様に取り扱ってください。

以下に、手短なチュートリアルを使用して API を使用する方法を説明します。このチュートリアルは、curl コマンドの形式をもつリクエストの例に基づいています。

コマンドを実行する前に、すべてのプレースホルダーを実際の値に置き換えてください。プレースホルダーは {{placeholder}} の形式になっています。

ほとんどのリクエストでは、{{project_id}} を実際のプロジェクト ID に置き換える必要があります。プロジェクト ID を見つけるには、Runtime Admin ツールにログインし、プロジェクトの設定ページを開きます。

プロジェクト ID の長さは最大 20 文字で、組織内で一意であることが必要です。

環境の使用

Managed Runtime API への最初のリクエストでは、プロジェクトに属するすべての環境 (API で「ターゲット」と呼ばれるもの) をリストします:

次に、production にデプロイする前に変更の確認に使用する、staging という名前の環境を作成します:

新しい環境を使用するには、その環境にバンドルをデプロイする必要があります。

作成した staging 環境の詳細を確認します:

最後に、staging のプロキシ構成を変更します:

構成を変更すると、現在のバンドルが自動的に再デプロイされ、変更が適用されます。

API の使用で問題が発生した場合は、以下のトラブルシューティングの手順を試してください。

--fail 引数を curl コマンドに追加します。
API キーを確認します。
プロジェクトの ID を確認します。

API エンドポイントはブラウザーでも機能します。Runtime Admin ツールにログインして、ブラウザーで直接使用しているエンドポイントを開きます。

ここでは、API の使用方法を学習し、リクエストのサンプルを作成しました。API の詳細については、API の仕様を参照してください。