REST API

概要

Sitecore CDPはREST APIを通じてリソースを公開しており、標準的なフォーマットでデータを柔軟に提供する方法を提供します。Sitecore CDP REST APIはリソース表現JSONサポートしています。

基本的なレベルでは、REST APIを使ってSitecore CDPへの同期アクセスを提供できます。REST APIを使ってデータを更新したり、現在の状態を読み取ったりできます。REST APIは重要な統合要件を満たし、マッシュアップでデータを容易に結合できるだけでなく、ベースのRESTサービス群を拡張することも可能にします。例えば、独自のカスタム属性を使い、それらをSitecore CDPリソースに利用可能にしたいかもしれません。これを行うには、スキーマのないJSONオブジェクトであるデータ拡張リソースを使い、特定の名前と値のペアを許可します。

以下はREST APIの特徴です:

• 同期通話のサポート
• 処理エラーを報告します
• サーバーサイドリクエストのサポート
• セッション認証
• データの読み書き
• オンラインデータキャプチャ(ODC)

REST APIの使用タイミング

以下のREST APIを使ってSitecore CDPリソースに対してCRUD操作を行えます:

• ゲストREST API - ゲストの行動データや取引データを扱うこと。
• ゲストデータ拡張REST API - お好みの追加のゲストデータに対応します。
• 注文、注文アイテム、注文コンタクト、注文消費者向けREST APIなど、注文関連データに対応するためのサービス。
• 注文データ拡張 および 注文アイテムデータ拡張 REST APIは、追加の注文および注文項目データに対応します。
• オーディエンスエクスポートREST API - Sitecore CDP外で使用するためにエクスポートされたオーディエンスデータにアクセスするためのもの。

Sitecore CDPは、RESTリソースの取得および更新のためにURLエンドポイントを公開するインタラクティブなWebサービスのスイートを展開することを可能にします。RESTトピックには以下の情報が含まれています:

• リソース属性
• 例行的な要求
• 回答例