Getting started with the Real-Time Customer Profile API getting-started
Using Real-Time Customer Profile API endpoints, you can perform basic CRUD operations against Profile data, 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 ÃÛ¶¹ÊÓƵ 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: Provides a unified, customer profile in real time based on aggregated data from multiple sources.
- ÃÛ¶¹ÊÓƵ Experience Platform Identity Service: Gain a better view of your customer and their behavior by bridging identities across devices and systems.
- ÃÛ¶¹ÊÓƵ Experience Platform Segmentation Service: Allows you to build audiences from Real-Time Customer Profile data.
- Experience Data Model (XDM): The standardized framework by which Platform organizes customer experience data.
- Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.
The following sections provide additional information that you will need to know in order to successfully make calls to Profile API endpoints.
Reading sample API calls
The Real-Time Customer Profile API documentation provides example API calls to demonstrate how to properly format requests. These include paths, required headers, and properly formatted request payloads. Sample JSON returned in API responses is also provided. For information on the conventions used in documentation for sample API calls, see the section on how to read example API calls in the Experience Platform troubleshooting guide.
Required headers
The API documentation also requires you to have completed the in order to successfully make calls to Platform endpoints. Completing 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: {ORG_ID}
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.
All requests with a payload in the request body (such as POST, PUT, and PATCH calls) must include a Content-Type header. Accepted values specific to each call are provided in the call parameters.
Next steps
To begin making calls using the Real-Time Customer Profile API, select one of the available endpoint guides.