APIヘッダー
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
Sitecore XCは、サービスAPIを介して渡されたヘッダーを使用して、呼び出しのコンテキストを確立します。これらのヘッダーは、すべての呼び出しで渡されるCommerceContext内から使用できます。インストール時にサポートされる標準の既知のヘッダーがあり、特定のプラグインに対して追加のヘッダーを確立できます。プラグインは、アクションを実行するときにこれらのヘッダーを参照できます。
一部のヘッダーは、特定のアクションにのみ関連します。ただし、特定の呼び出しで使用されていないヘッダーを含めることは害にはなりません。
サポートされているヘッダーは次のとおりです。
|
名前 |
使い |
|---|---|
|
ショップ名 |
アクセスしている現在のショップの名前。 |
|
ショッパーID |
買い物客の一意のID。これは通常、文字列として表されるGUIDです。 |
|
カスタマーID |
ショッパーが登録されている場合は、登録済みの顧客の一意のIDを表す追加のIDが渡されます。これは通常、文字列として表されるGUIDです |
|
通貨 |
応答に必要な通貨。たとえば、SellableItemをリクエストすると、希望の通貨 (利用可能な場合) で価格が表示されます。 |
|
言語 |
応答に必要な言語。たとえば、SellableItemをリクエストすると、目的の言語 (利用可能な場合) でローカライズされた文字列が表示されます。 |
|
エフェクティブ・デート |
日付ベースの計算中に使用する発効日。これにより、タイムトラベルのシナリオで、インタラクションが現在にない日時に発生したかのように結果を表示したい場合があります。EffectiveDateが渡されない場合は、DateTime.UtcNowが使用されます。 |
|
緯度 |
ショッパーの現在の緯度を表す文字列。 |
|
経度 |
ショッパーの現在の経度を表す文字列。 |
|
IPアドレス |
ショッパーのIPアドレス。 |
|
役割 |
呼び出し元のロールの "|" 区切りリスト。これは、許可されるアクション、クエリで返される情報、またはクエリを実行できるかどうかに影響を与える可能性があります。セキュリティ上の理由から、フェデレーション認証で認証されると、これらのロールは無視され、ロールは認証トークンから直接派生します。 |
|
登録済み |
現在の呼び出し元が登録されていることを示す文字列として表されるブール値。 |