The Stream API lets you send real-time behavioral and transactional data about the users of your application to Sitecore CDP. Using the Stream API involves integrating your application with Sitecore CDP.
We recommend that you integrate using the Sitecore Engage SDK.
Sitecore CDP provides a suite of API services that makes data management easier, faster, and more efficient. The Stream API captures fast-flowing, high-velocity event data at the same time that it is generated on your organization's website. When you integrate your application using the Engage SDK, the Engage SDK uses the Stream API behind the scenes to facilitate the capturing of events. The Stream API can also be deployed in conjunction with your organization's data layer.
The Stream API consists of two APIs. If you integrate your application using direct HTTP requests, you make requests to both of the following APIs:
Browser API - the Browser Interface enables you to extend functionality within a web browser or other HTTP client. You can use the Browser Interface to manage cookies in the browser that help identify guests and facilitate personalization.
Event API - the Event Interface enables event processing. For example, you can use the Event API to send events in at speed from mobile applications or your website.
The Stream API has the following characteristics:
Supports synchronous calls
Sends write-only data
Processes structured data
Captures online events
Facilitates Online Data Capture (ODC)
When to use the Stream API
The Stream API provides a light-touch integration that facilitates the immediate realization of Sitecore CDP functionality. The Stream API is used for the following purposes:
Online data capture - you can integrate the Stream API with your data layer to capture guest activity as guests navigate your online booking flow. Sitecore CDP can also integrate with your website, mobile app, and call center.
Behavioral information - the Event API captures a guest's behavioral data that can immediately be used in real-time personalization. These are events, for example, the pages the guest visits, the searches the guest performs, purchased products, and products added to the cart but not purchased.