SDK Usage Examples (Winter ‘20 version)

This topic and the topics that follow illustrate several examples for instantiating and using the Digital Commerce SDK.

1// Instantiate DigitalCommerceConfig for anonymous user
2const digitalCommerceConfig = VlocitySDK.digitalcommerce.createConfigForAnonymousUser();
3
4// Instantiate the SDK itselfconst digitalCommerce = VlocitySDK.digitalcommerce.getInstance(digitalCommerceConfig);
5
6OR
7
8// Instantiate DigitalCommerceConfig for login user
9const digitalCommerceConfig = VlocitySDK.digitalcommerce.createConfigForLoginUser(salesforceUrl, sessionToken);
10
11// Instantiate the SDK itself
12const digitalCommerce = VlocitySDK.digitalcommerce.getInstance(digitalCommerceConfig);
13
14// To override the default namespace with your custom namespace
15this.digitalCommerce.namespace = "vlocity_cmt"; // use your custom namespace
16
17// To override the default custom api URL with your custom api URL
18this.digitalCommerce.apiURL = "YOUR_CUSTOM_API_URL"; // use your custom URL
19
20// To override the default api URL
21authTokenthis.digitalCommerce.authToken = "YOUR_CUSTOM_AUTH_TOKEN"; // use your custom authToken
22
23Note:
24digitalCommerce is a Singleton object.  Calling getInstance(digitalCommerceConfig) repeatedly will return the same instance instantiated the first time when getInstance(digitalCommerceConfig) was called.
25
26// To instantiate a new instance of digitalCommerce, set create to true in the digitalCommerceConfig object:
27digitalCommerceConfig.create = true;
28digitalCommerce = VlocitySDK.digitalcommerce.getInstance(digitalCommerceConfig);```

Possible error conditions:

“VlocityDigitalCommerce::getInstance: Config object must be given in argument to create an instance the first time.”
“VlocityDigitalCommerce::constructor: VlocityDigitalCommerce cannot be instantiated properly. Both datasource and user context objects have to be in Config object as argument.”