ランタイムエンドユーザーエクスペリエンスで使用される API のリストを、その目的および応答とともに表示します。

CPQ API は、ランタイム API と管理 API の 2 つのカテゴリに分類されます。この記事では、トランザクション マネージャーのランタイム API を一覧表示します。

ランタイム API は、ランタイムエンドユーザーエクスペリエンスで使用されるものと同じで、次のキーアクションが含まれています。

• セッションを初期化する
  • 目的:セッションを初期化して、トランザクションイベントを実行し、ステータスを管理し、後続の API 呼び出しを処理するためのコンテキストを確立します。既存のトランザクションに対して初期化できます。トランザクションが指定されていない場合は、新しいトランザクションが作成されます。
  • 応答:セッション ID、トランザクション ID、およびトランザクション情報を返します。
• セッションを削除する
  • 目的:セッションを削除して、ユーザーアクティビティを安全にエンドし、セッション固有のデータをクリアして、システムリソースを解放します。
  • 応答:セッションは削除されています。情報は返されません。
• トランザクションを作成
  • 目的:トランザクションを作成し、トランザクションのライフサイクルを管理し、製品を構成および追加し、価格設定を決定するオブジェクトを提供します。
  • 応答:トランザクション ID とトランザクション情報を返します。
• トランザクションでイベントを実行 (システムおよびカスタム)
  • 目的:トランザクションで指定されたイベントをトリガーして、フィールド値の編集、承認の開始、トランザクションのバージョニング、構成の検証など、事前定義されたロジックまたはワークフローを実行します。
  • 応答:イベントによって異なります。
• トランザクションに製品を追加する (アップサート)
  • 目的:製品をトランザクションに追加し、製品の属性に基づいて動的な構成と価格設定の更新を有効にします。
  • 応答:追加の製品とともに更新されたトランザクションデータを返します。
• トランザクションのリストを取得
  • 目的:トランザクションのリストを取得し、ユーザーが既存のトランザクションを表示、管理、またはアクションを実行できるようにします。
  • 応答:トランザクション ID とその他のメタデータを含むトランザクションのリスト。
• トランザクションの詳細を取得
  • 目的:トランザクションのヘッダー情報を取得し、表示や処理に必要なステージ、アカウント、サマリーレベルのデータなどの重要な詳細を提供します。
  • 応答:トランザクションのすべてのヘッダーフィールドデータ。
• トランザクションの明細を取得
  • 目的:トランザクションの品目の詳細を取得し、見積もりの各アイテムの数量、価格設定、カスタム属性などの製品レベルのデータを返します。
  • 応答:トランザクションのすべての明細レベルのフィールドデータ。
• トランザクションの統計情報を取得
  • 目的:トランザクションのメトリクスを取得します。メトリクスには、ユーザー別のビュー、ユーザー別のセッション時間、ステージ時間が含まれます。
  • 応答:過去 30 日間または指定された日付範囲のサマリーメトリクス。

  トランザクションマネージャーメトリクス API の詳細については、「 トランザクションマネージャー:トランザクションメトリクス API」を参照してください。

Postman コレクション