SDK Reference

This is the main API for accessing all the SDK components. The initialize() method takes HostInfo and an optional ConfigParams, and returns a CCEverywhere object.

initialize()

The default method initialize() is the API used to initialize the SDK. Make sure to call it only once a page.

// after loading the SDK into the window
window.CCEverywhere.initialize(
    /* HostInfo */
    {
        clientId: YOUR_CLIENT_ID,
        appName: YOUR_PROJECT_NAME,
        appVersion: { major: 1, minor: 0 },
        platformCategory: 'web', 
        redirectUri: YOUR_REDIRECT_URI
    },
    /* ConfigParams (optional) */
    {
        locale: 'en_US',
    }
);
Copied to your clipboard
1// after loading the SDK into the window
2window.CCEverywhere.initialize(
3    /* HostInfo */
4    {
5        clientId: YOUR_CLIENT_ID,
6        appName: YOUR_PROJECT_NAME,
7        appVersion: { major: 1, minor: 0 },
8        platformCategory: 'web', 
9        redirectUri: YOUR_REDIRECT_URI
10    },
11    /* ConfigParams (optional) */
12    {
13        locale: 'en_US',
14    }
15);

HostInfo

Property	Type	Description
clientId	string	Your API Key
appName	string	Name of project folder created in user's CC Express
appVersion	{ major: number, minor: number, patch?: number}	Your app version
platformCategory	'web'	Specify host app platform
redirectUri	string	Searches for redirect URL you define in console

If you specify redirectUri as a parameter in the HostInfo object, that is the redirect URI that will be checked first. If you leave this field blank, IMS will search through the "Redirect URI patterns" registered in console for your client, and if no match is found, it will fall back on the "Default Redirect URI".