This is an old documentation. Go to the latest Customer's Canvas docs

IFrame API

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.

    <meta charset="utf-8" />
    <!-- The IFrame API script. IMPORTANT! Do not remove or change the ID. -->
    <script id="CcIframeApiScript" type="text/javascript" src="">
For details, see the Getting Started with IFrame API topic.


Name Description

The module containing basic widget interfaces.


The Iframe Api module. It provides data and methods for a product handling.