データ取得 API の使用の手引き

データ取得 API エンドポイントを使用して、基本的な CRUD 操作を実行し、Adobe Experience Platformでデータを取り込むことができます。

API ガイドを使用するには、データの操作に関わる複数のAdobe Experience Platformサービスに関する十分な知識が必要です。 データ取得 API を使用する前に、次のサービスのドキュメントを確認してください。

  • バッチ取得:データをバッチファイルとして Adobe Experience Platform に取得することができます。
  • Real-time Customer Profile:複数のソースからの集計データに基づいて、統合された顧客プロファイルをリアルタイムで提供します。
  • Experience Data Model (XDM): Platform が顧客体験データを整理するための標準的なフレームワーク。
  • Sandboxes:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

以下の節では、への呼び出しを正しくおこなうために知っておく必要がある追加情報を示します。 Profile API エンドポイント。

API 呼び出し例の読み取り

データ取得 API のドキュメントには、API 呼び出しの例とリクエストの形式を適切に設定する方法が記載されています。 これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。

必須ヘッダー

また、API ドキュメントでは、 エンドポイントを正しく呼び出すために、認証に関するチュートリアルを完了している必要があります。Platform次に示すように、Experience Platform API 呼び出しにおける各必須ヘッダーの値は認証チュートリアルで説明されています。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

リクエスト本文にペイロードを持つすべてのリクエスト(POST、PUT、PATCH 呼び出しなど)には、Content-Type ヘッダーが含まれている必要があります。各呼び出しに固有の受け入れられた値は、呼び出しパラメーターに指定されます。

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。へのリクエスト Platform API には、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name: {SANDBOX_NAME}

Platform のサンドボックスについて詳しくは、サンドボックスの概要に関するドキュメントを参照してください。

このページ