Getting started with the Real-time Customer Profile API

Using the Real-time Customer Profile API, you can perform basic CRUD operations against Profile resources, such as configuring computed attributes, accessing entities, exporting Profile data, and deleting unneeded datasets or batches.

Using the developer guide requires a working understanding of the various Adobe Experience Platform services involved in working with Profile data. Before beginning to work with the Real-time Customer Profile API, please review the documentation for the following services:

  • Real-time Customer Profile:複数のソースからの集計データに基づいて、リアルタイムで統合された顧客プロファイルを提供します。
  • Adobe Experience Platform Identity Service:デバイスとシステム間でIDをブリッジ化することで、顧客と行動をより良く表示できます。
  • Adobe Experience Platform Segmentation Service:リアルタイム顧客プロファイルデータからオーディエンスセグメントを作成できます。
  • Experience Data Model (XDM):プラットフォームが顧客体験データを編成する際に使用する標準化されたフレームワーク。
  • Sandboxes: Experience Platform は、1つの Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

The following sections provide additional information that you will need to know in order to successfully make calls to Profile API endpoints.

API 呼び出し例の読み取り

The Real-time Customer Profile API documentation provides example API calls to demonstrate how to properly format requests. この中には、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform


また、API ドキュメントでは、 エンドポイントを正しく呼び出すために、認証に関するチュートリアルを完了している必要があります。PlatformCompleting the authentication tutorial provides the values for each of the required headers in Experience Platform API calls, as shown below:

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

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

For more information on sandboxes in Platform, see the sandbox overview documentation.

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


APIを使用した呼び出しを開始するには、使用可能なエンドポイントガイドの1つを選択します。 Real-time Customer Profile