I’ve started a collection based on the Sitecore documentation and examples they've provided. You can import it into Postman and use it when working with your own Sitecore CDP sandbox. I hope you find it useful, please share any feedback.
To use the collection against your sandbox you need to authenticate, Sitecore CDP supports basic authentication. An API token is a unique key that Sitecore provides your organization to authenticate your services.
1. You need to obtain your client key and API token from Sitecore CDP, in the navigation pane, click System Settings -> API Access. For basic authentication:
- Username = Sandbox API Access Client Key
- Password = Sandbox API Token
2. You will need to update the variables in the postman collection:
- apiKeyId = Sandbox API Access Client Key
- apiKeySecret = Sandbox API Token
Here is a list of current variables within the collection:
| Variable | Description | Examples |
| apiKeyId | Your Sandbox API Client Key | |
| apiKeySecret | Your Sandbox API Token | |
| apiEndpoint | All URLs referenced in the Sitecore CDP v2.1 API data model begin with the following base URL: https://{apiEndpoint}/v2 | api.boxever.com |
| pointOfSale | A POS is a specific storefront your organization sells products. Sitecore CDP supports multiple storefronts certain requests need to target the correct storefront. | betaSpinAir |
| currencyCode | The type of currency used for requests. String value (3 letter ISO 4217). | "EUR", "USD", "GBP" |
| language | The language captured on each page the guest visited. | "EN", "FR", "DE" |
| channel | The channel captured on each page the guest visited. | "WEB", "MOBILE_WEB", "MOBILE_APP" |
| guestRef | The unique ID of the guest generated by Sitecore CDP. | guid |
| guestEmail | The email address for the guest. | |
| identifiersProvider | The provider of the identifiers. | ProfileSystem |
| identifiersId | The ID of the identifiers. | guid |
| dataExtensionName | The data extension name. | extEmailPreferences |
| dataExtensionRef | The reference of the data extension. | guid |
| orderRef | The reference of the order. | guid |
| orderItemRef | The reference of the order item. | guid |
| orderContactRef | The reference of the contact on the order. | guid |
| orderConsumerRef | The reference of the consumer on the order. | guid |
| batchFlowsJobRef | The reference of the Batch flow. | guid |
| decisionModelDefinitionRef | The reference of the Decision Model Definition. | guid |
| decisionModelDefinitionRevision | The reference of the Decision Model Definition Revisions. | guid |
| decisionModelVariantRef | The reference of the Decision Model Variant. | guid |
| decisionModelVariantRevision | The reference of the Decision Model Variant Revision. | guid |
| connectionRef | The reference of the Connection. | guid |