Welcome to the Javascript based SDK for using the Sitecore Personalize Tenant/Admin APIs. This repository is useful if you want to create integrations with these APIs. This repository is used by many other repositories such as the Serializer for CDP/Personalize, Automation Testing Scripts and some AI powered integrations I'm working on. Currently this only supports the Cloud Portal for Sitecore CDP/P.
This IS NOT for ingestion of event data, you should use the Sitecore Engage SDK or Cloud SDK depending on your usage needs. (https://doc.sitecore.com/xmc/en/developers/sdk/latest/cloud-sdk/cloud-sdk-and-engage-sdk-comparison-chart.html)
To get started using this SDK, you should first install the package as a dependency in your Node project:
> npm install sitecore-personalize-tenant-sdkOnce it's installed you'll need to initialize the client:
import { Client, RegionOptions, TemplateType } from 'sitecore-personalize-tenant-sdk';
let client: Client;
client = new Client({
clientId: '<ClientId>',
clientSecret: '<ClientSecret>',
region: RegionOptions.EU,
});
let response = await client.Templates.GetAll(TemplateType.Web);This module is built to support ESM and CommonJS.
You can get setup for local development by cloning the repository and running the following commands:
$ npm install
$ npm run dev
This will start the app in the current terminal window, where changes to the current files, will be reflected immediately (via a watch command with tsup).
Below is a table that provides details about what is and is not supported currently from Sitecore Personalize. This SDK is currently in active development and the goal is full support with the available APIs, however it is noted below, some cases where the Sitecore Personalize APIs do not support the functionality.
| Feature | Supported | Notes |
|---|---|---|
| Experiments (Flow) | In Progress: Lots of work still left | |
| Experiences (Flow) | In Progress: Lots of work still left | |
| Decision Models | Use at your own risk! | |
| Templates (Web) | ✅ | None |
| Templates (Conditions) | ✅ | None |
| Templates (JS Modules) | ✅ | None |
| Templates (Decisions) | ✅ | None |