Collect required details
During integration, you have to provide details about your Sitecore Personalize instance, so we recommend you collect the following necessary information before you start integrating.
Client key
The client key is your organization's unique and public identifier.
To find your client key, in Sitecore Personalize, on the navigation pane, click 
> Company information > Client key.
Stream API target endpoint
When you integrate, you send data using the Stream API. Your Stream API target endpoint depends on the environment of your Sitecore Personalize instance.
To find the environment, in Sitecore Personalize, on the navigation pane, click > Company information > Environment.
| Environment | Stream API target endpoint |
|---|---|
| AP Region | https://api-engage-ap.sitecorecloud.io |
| EU Region | https://api-engage-eu.sitecorecloud.io |
| JP Region | https://api-engage-jpe.sitecorecloud.ioImportant
To run web personalization in this environment, load the web personalization script from the following URL:
|
| US Region | https://api-engage-us.sitecorecloud.io |
Name of point of sale
To find the name of your point of sale, in Sitecore Personalize, on the navigation pane, click > Points of Sale > Name.
Channel, language, and currency
Channel, language, and currency are part of the data you send.
| Parameter | Type | Description | Example |
|---|---|---|---|
channel | string (uppercase) | The touchpoint where the user interacts with your brand. For example, for webpages, the channel is "WEB". For mobile app screens, the channel is "MOBILE_APP".See the full list of allowed values. |
|
language | string (uppercase ISO 639-1) | The language the user is using your app in. For example, if the user selects the Japanese language on your website, the language is "JA". |
|
currency | string (uppercase ISO 4217) | The alphabetic currency code of the currency the user is using in your app. For example, if the user selects Australian dollars as the currency on your website, the currency is "AUD". |
|
Cookie domain (optional)
If you integrate using the Engage SDK, you can specify your cookie domain. The cookie domain is the top-level domain of the website you are integrating. The cookie domain ensures that Sitecore Personalize stores cookies in the web browser as first-party cookies.
| Scenario | Example domain | Cookie domain |
|---|---|---|
| Integrating the main domain, including all subdomains. | www.myretailsite.com | ".myretailsite.com" |
| Integrating a subdomain only. | beta.myretailsite.com | ".beta.myretailsite.com" |
| Integrating a website on localhost. | localhost | "localhost" |
Web personalization (optional)
Decide whether you want to run web personalization with Sitecore Personalize. This affects how you initialize the Engage SDK.