SitecoreCDP.SDK 1.0.0-alpha3

Sitecore CDP/Personalize SDK for .NET

The unofficial .Net SDK for Sitecore CDP/Personalize

• Example
• Available services
  • Batch API
  • AudienceSync API
  • Interactive API (REST)
  • Stream API
  • Tenant API
• FAQ
• Supported Platforms
• Getting Help
• Helpful Links

Example

using SitecoreCDP.SDK;

// initialize client
var cdpClient = new CdpClient(new CdpClientConfig
{
    ClientKey = "tenant-client-key",
    ApiToken = "tenant-api-token",
    
    BaseUrl = "https://api-engage-eu.sitecorecloud.io", // or "https://api.boxever.com"
    Version = "v2"
});

// batch import
var batchRef = await cdpClient.BatchApi.UploadJson("import.json");

...

// check status
var status = await cdpClient.BatchApi.CheckStatus(batchRef);
if (status.Status.Code == BatchStatusCode.Error)
{
	// download log and extract error records
    var logRecords = await cdpClient.BatchApi.DownloadBatchLog(status.Status.LogUri);
    var errorRecords = logRecords.Where(x => x.Code != 200);
}

Available services

At this moment Batch API, Interactive API and Audience Sync are ready. Stream API and Tenant API are in progress.

Batch API

Batch API is used to upload guests, orders, and tracking events. The are 3 types of supported import formats:

• Model based:

var batchRef = await cdpClient.BatchApi.Upload(new List<Batch>
{
    new BatchGuest { Guest = new Guest() {/* populate fields */ } },
    new BatchOrder {Order = new Order(){ /* populate fields */}},
	...
});

• JSON file:

var batchRef = await cdpClient.BatchApi.UploadJson("import.json");

• GZip file:

var batchRef = await cdpClient.BatchApi.UploadGZip("import.json.gz");

Check batch import status and download error log in strongly typed records:

// check status
var status = await cdpClient.BatchApi.CheckStatus(batchRef);
if (status.Status.Code == BatchStatusCode.Error)
{
	// download log and extract error records
    var logRecords = await cdpClient.BatchApi.DownloadBatchLog(status.Status.LogUri);
    var errorRecords = logRecords.Where(x => x.Code != 200);
}

AudienceSync API

AudienceSync REST API to trigger and retrieve batch jobs, download output files.

var triggerResponse = await cdpClient.AudienceSyncApi.Trigger(flowRef, segmentRef, datasetDate);

var jobStatus = await cdpClient.AudienceSyncApi.CheckStatus(triggerResponse.Ref);
if (jobStatus.Status == TriggerResponseStatus.Success)
{
    await cdpClient.AudienceSyncApi.GetOutputFiles(triggerResponse.Ref, "outputFiles.gz");
}

Interactive API (REST)

• Guest API: cdpClient.InteractiveApi.Guests
• Guest Data extensions API: cdpClient.InteractiveApi.GuestExtensions
• Orders API: cdpClient.InteractiveApi.Orders
• OrderItems API: cdpClient.InteractiveApi.OrderItems

Stream API

In progress.

await cdpClient.StreamApi.RunExperiment(friendlyId);
await cdpClient.StreamApi.IdentifyUser(new IdentityEvent{});
await cdpClient.StreamApi.TrackEvent(new Event{});
await cdpClient.StreamApi.CreateNewSession();
await cdpClient.StreamApi.AbandonSession();

Tenant API

In progress.

FAQ

Do I have to use async/await when calling endpoints?

Yes. The SDK uses HttpClient, which does not support synchronous calls (and for good reason). Do not use .Result or .Wait() on calls made with this SDK, ever. These will block threads and potentially cause deadlocks. In short, don't block on async code. Use await.

Supported Platforms

The SDK is available with .NET 7.0, .NET Framework 4.6.x and .NET Standard 2.x that makes it compatible with almost all .NET solutions.

Getting Help

For programming questions you can ask me in Sitecore Slack channels @x3mxray.

To report a bug or request a feature specific to the SDK, please open an issue.

Helpful Resources

• CDP Integrations - Developer Portal
• Sitecore CDP developer documentation
• Dylan Young: JS SDK/API spec/Postman collection