Today I am going to explain the basics of Batch API in Sitecore CDP.
Sitecore CDP is an enterprise-level customer data platform that helps various businesses to manage and lift their customer data to drive better customer personalization and experiences. The Sitecore CDP is designed to provide an exceptional experience to every individual on all digital channels. The functionality of CDP's data management is augmented with decisions, predictive analytics, experimentation, and orchestration.
One of the key features of Sitecore CDP is its Batch API which allows various businesses to process large amounts of customer data quickly and efficiently.
What is Batch API in Sitecore CDP?
The Batch API is a REST API that can be used by businesses to process large amounts of customer data in batches. This API can be used to create, update, or delete customer profiles.
Sitecore CDP Batch API supports efficiently uploading large amounts of data to Sitecore CDP. You can use the Batch API to upload guests, and orders as well as track events which organizations can source in bulk from their internal systems and send to the Sitecore CDP platform for processing.
The Batch API is designed to be highly scalable which means that it can handle a large amount of data without getting slowed down or crashing. It is also highly secure with the help of encryption and authentication to protect sensitive customer data.
Working on Batch API in Sitecore CDP
To start working with the Batch API you must first create a batch job. This involves defining the dataset that is to be processed as well as defining any additional parameters such as the desired output format or any required data transformations.
Once the batch job has been created you can submit it to the Batch API for processing. The Batch API will then split the data set into smaller batches and distribute them across multiple servers for processing in parallel.
After a batch file has been submitted for processing you can periodically check on the progress of the batch import until the batch has been completely processed. You can interrogate the Batch API at any time to check the status of a batch that is being processed and to view any success or failure messages which might be logged after the processed batch is complete.
You can access the Batch API using the same secure credentials that you use to access the Interactive REST API. You also need the Base URL and API endpoints.
Once the processing is completed the Batch API will return the results which can then be downloaded and analyzed as needed.
Benefits of Batch API in Sitecore CDP
The Batch API in Sitecore CDP provides several benefits for the businesses such as:
Efficiency: Batch API supports asynchronous requests which means multiple batch imports can be initiated in parallel which helps businesses to reduce processing times and increase efficiency.
Security: Batch API supports encryption and authentication which helps to protect the customer data from unauthorized access.
Scalability: The Batch API is highly scalable which means that businesses can process large amounts of data quickly and efficiently without getting slow down or crashing.
Flexibility: The Batch API can be used to create, update, and delete customer profiles, and orders as well as track events. This makes it a highly flexible tool that can be customized to meet the specific needs of businesses.
Sitecore Personalize developer documentation - https://doc.sitecore.com/personalize/en/developers/api/index-en.html
Batch import for Sitecore CDP failing - https://sitecore.stackexchange.com/questions/30854/why-is-my-batch-import-for-sitecore-cdp-failing
Later I will explain the working of Batch API practically.
Till then Happy
Coding