Getting started with the Data Ingestion API getting-started
Using Data Ingestion API endpoints, you can perform basic CRUD operations in order to ingest data in ÃÛ¶¹ÊÓƵ Experience Platform.
Using the API guides requires a working understanding of multiple ÃÛ¶¹ÊÓƵ Experience Platform services involved in working with data. Before using the Data Ingestion API, please review the documentation for the following services:
- Batch ingestion: Allows you to ingest data into ÃÛ¶¹ÊÓƵ Experience Platform as batch files.
- Real-Time Customer Profile: Provides a unified, customer profile in real time based on aggregated data from multiple sources.
- 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 Data Ingestion 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 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.
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.