You’re viewing outdated documentation. View the latest Customer’s Canvas On-Premises documentation.

IFrame API

Applies to: Customer's Canvas On-Premises; Design Editor 6.15.0, 6.x (may differ) · Archived documentation

To use the Customer's Canvas IFrame API, you should link the IframeApi.js script located in ~/Resources/Generated/. In addition, you need to specify a URL leading to Customer's Canvas instance - either by adding id="CcIframeApiScript" to the script tag or using the IframeApi.editorUrl property. Here is the simplest way to enable IFrame API on your page.

<head>
    <meta charset="utf-8" />
    <!-- The IFrame API script. IMPORTANT! Do not remove or change the ID. -->
    <script id="CcIframeApiScript" type="text/javascript" src="http://example.com/Resources/Generated/IframeApi.js">
    </script>
</head>

For details, see the Getting Started with IFrame API topic.

Modules

Name	Description
BaseEditor	The module containing basic widget interfaces.
IframeApi	The Iframe Api module. It provides data and methods for a product handling.