j1.1.4
API の概要
B2C Commerce バージョン 24.7.2 で利用可能なこの API では、変化するビジネスニーズや技術統合に対応できるよう、B2C Commerce チームがサイト固有および環境固有の設定を定期的に構成できます。多くの場合、Storefront Reference Architecture (SFRA)/SiteGenesis の実装では、デプロイや大規模なエンジニアリングサポートを必要とせずにこれらの設定を変更するために、宣言的なカスタムサイト環境設定を使用します。サイト環境設定を使用すると、チームは最小限の労力でサイトを調整できます。
次の Preferences API エンドポイントでは、環境設定に関連する情報を取得します。
- グローバルカスタム環境設定: 組織レベルのすべてのカスタム環境設定を取得します。
-サイのカスタム設定: サイトレベルのすべてのカスタム環境設定を取得します。
Preferences API はまず、カスタム値が設定されているかどうかを確認し、設定されている場合はそのカスタム設定を返します。設定されていない場合は、Business Manager で提供されるデフォルト値を返します。
注: Preferences API ではカスタム環境設定を設定します。カスタム以外の環境設定の扱いについては、B2C Commerce のグローバル環境設定および B2C Commerce のサイト環境設定を参照してください。
認証と認可
カスタム環境設定 API では、Admin API の Account Manager トークンが必要です。
SLAS トークンの生成に使用するクライアント ID には、関連するスコープを含める必要があります。詳細については、認可スコープカタログを参照してください。
ユースケース
グローバルカスタム環境設定:
ある大手プライベートエクイティ企業は、多様なブランドのポートフォリオを管理しており、それぞれのブランドが独自のサイトを運営しています。これらのブランドはそれぞれ独自性を持ちながらも、決済やコンテンツ管理などの重要な機能については、共通のサードパーティ統合を活用しています。同社は一元的なアプローチを通じて、決済ポータルのような主要コンポーネントの仕様を定義し、すべてのサイトで一貫性と効率性を確保しています。これらの仕様は綿密に策定されており、運用の安定性を維持しつつ変化するニーズに対応するため、変更はまれにしか行われません。
サイトカスタム環境設定:
サイト運営者は、自社サイト向けに調整された多数のテストや機能を持つ場合があります。こうした機能を効率よく制御できるようにするには、必要に応じてマーチャントチームが簡単にオン/オフを切り替えられる、使いやすい仕組みが必要です。Site Preference API は、この仕組みを提供します。
キャッシュ
Preferences API ではキャッシュ機能を利用できます。詳細については、サーバー側の Web 階層キャッシングを参照してください。
環境設定
Let us know so we can improve!