SDK Reference

IMPORTANT: Deprecation Warning

We are no longer approving integrations using v1 or v2 of the SDK - both versions will be deprecated in 2024.

This is the main API for accessing all Adobe Express Embed 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', 
    },
    /* ConfigParams (optional) */
    {
        locale: 'en_US',
    }
);
Copied to your clipboard
// 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', 
    },
    /* ConfigParams (optional) */
    {
        locale: 'en_US',
    }
);

HostInfo

Property	Type	Description
clientId	string	Your API Key
appName	string	Name of project folder created in user's Adobe Express account
appVersion	{ major: number, minor: number, patch?: number}	Your app version
platformCategory	'web'	Specify host app platform