API の概要とリソース
構成を管理するために CPQ で利用可能な API について説明します。
CPQ は、構成のエンドユーザー (ランタイム) と、セットアップと管理の管理側の両方に API を提供します。
ランタイム API は、 CPQ 構成の標準的な作成、読み取り、更新、および削除機能と、部品表 (BOM) データを CPQから取得する機能をサポートしています。これらの API を使用して、エンドユーザーが CPQ 構成を作成するためのヘッドレス UI またはカスタム UI をビルドできます。
管理用 API を使用して、詳細計画、フィールド、セット、製品ピッカー、ルール、管理テーブル、およびインポートおよびエクスポート用のマトリクスローダーを操作できます。アドミン API を統合または自動化して、データ移行などの日常的なタスクを実行できます。
API リソース
次のリソースは、 CPQ API の使用を開始するのに役立ちます。
OpenAPI 仕様と CPQ API の Postman コレクションを含む Github リポジトリを表示するには、以下を参照してください。
ランタイム API とアドミン API の両方のコード例を含む、インタラクティブで探索可能な API ドキュメントについては、以下を参照してください。
API 呼び出しの認証
ランタイム API 呼び出しは、 CPQ アドミンで定義されたランタイムクライアントトークンを使用して認証されます。ランタイム API 呼び出しとランタイムクライアントトークンの詳細については、以下を参照してください。
管理用 API 呼び出しは、 CPQ アドミンでも設定されている管理 API トークンで認証されます。アドミン API トークンと権限の詳細については、以下を参照してください。