構成値
Salesforce Commerce API を使用する各 B2C Commerce インスタンスについて、そのインスタンスに関連する構成値のセットを収集する必要があります。これらの構成値は、設定プロセスを完了し、API リクエストを作成するために必要です。
一般的な構成値のセットは次のようなものです。
| 構成値 | 例 |
|---|---|
| 組織 ID | f_ecom_zzte_053 |
| ショートコード | kv7kzm78 |
| サイト ID | RefArch |
このガイドでは、各構成値の詳細と、その値をどこで見つけることができるかについて説明します。
組織 ID は、B2C Commerce インスタンスを識別する短い文字列です。各インスタンスは、それぞれ専用の組織 ID (f_ecom_zzte_053 など) をもちます。
インスタンスの組織 ID は、Business Manager で調べることができます。この場合、Account Manager で Business Manager Administrator (管理者) の役割をもっていて、インスタンスの Business Manager URL を知っている必要があります。
Business Manager URL は次のようになります。
組織 ID を調べるには、次のようにします。
- インスタンスの Business Manager URL を開きます。
- Account Manager の認証情報を使用してログインします。
- 管理 > サイトの開発 > Salesforce Commerce API 設定の順に移動します。
組織 ID がページに表示されます。クリップボードにコピーをクリックし、後で参照しやすい場所にペーストしておきます。
組織 ID で、2 つ目の下線文字 (_) の間にある部分は、レルム ID と呼ばれる 4 文字の文字列です。組織 ID が f_ecom_zzte_053 の場合、レルム ID は zzte です。
レルムは、B2C Commerce インスタンスのセットを示し、これにはプライマリインスタンスとセカンダリインスタンスの両方が含まれます。レルムの詳細については、B2C Commerce ドキュメントの概念と用語を参照してください。
組織 ID で、3 つ目の下線文字 (_) の後にくる部分は、インスタンス ID と呼ばれる 3 文字の文字列です。組織 ID が f_ecom_zzte_053 の場合、インスタンス ID は 053 です。
インスタンス ID は、レルム内のインスタンスを認識するための 3 文字の文字列です。
- Production (本番)、Staging (ステージング)、Development (開発) の各インスタンスのインスタンス ID は、それぞれ
prd、stg、devです。 - On-Demand Sandbox (オンデマンドのサンドボックス) のインスタンス ID は 3 桁の数字で、Sandobox が作成されるのに応じて増えます。
- POD Sandbox の場合、インスタンス ID の書式は
sXXで、XXは 01 から 99 までの間の数字を指します。
B2C Commerce インスタンスは、Shopper Login and API Access Service (SLAS) などの補助システムに関連付けられている場合に、「テナント」と見なされます。インスタンスを SLAS などのシステムに関連付けるには、インスタンスをテナント ID で識別する必要があります。テナント ID は 4 文字のレルム ID で開始し、それに、下線 (_) とインスタンス ID が続きます。
さまざまなタイプのインスタンスのテナント ID の例を以下に示します。
| インスタンスタイプ | レルム ID | インスタンス ID | テナント ID |
|---|---|---|---|
| Staging (ステージング) | bcgl | stg | bcgl_stg |
| On-Demand Sandbox (オンデマンドのサンドボックス) | zzte | 053 | zzte_053 |
| POD Sandbox (POD サンドボックス) | zzrf | s01 | zzrf_s01 |
ショートコードは、ルーティングの目的でレルムに割り当てられる 8 文字の文字列です。ショートコードはレルム全体に、すべてのインスタンスにまたがって適用されます。
ショートコードは組織 ID と同じ場所にあります。以下の方法で調べることができます。
- インスタンスの Business Manager URL を開きます。
- Account Manager の認証情報を使用してログインします。
- 管理 > サイトの開発 > Salesforce Commerce API 設定の順に移動します。
レルムで B2C Commerce API を使用したことがない場合は、ショートコードのリクエストをクリックしてリクエストします。
ショートコードが CDN および構成に含まれるすべてのルーティングシステムに読み込まれるまでに、最大で 24 時間かかることがあります。
ショートコードは api.commercecloud.salesforce.com と連結されて、API 呼び出しのための API ホスト名となります。たとえば、u8ak193h.api.commercecloud.salesforce.com となります。
サイト ID は、アクセスしたいデータが含まれるサイトの名前 (「チャネル」と呼ばれることもある) です。たとえば、RefArch や SiteGenesis などです。
Business Manager でサイトのリストを確認するには、次のようにします。
- インスタンスの Business Manager URL を開きます。
- Account Manager の認証情報を使用してログインします。
- 管理 > サイト > サイトの管理の順に移動します。
サイト名の詳細については、B2C Commerce ドキュメントの Create a Site in Business Manager (Business Manager でのサイトの作成) を参照してください。
B2C Commerce インスタンスの構成値をすべて収集したら、次の入門ガイドの認可に進んでください。