---
title: "IFrame API"
canonical: https://customerscanvas.com/docs/cc6/customerscanvas.htm
archived: true
applies_to:
  - product: "Customer's Canvas On-Premises"
  - product: "Design Editor"
    versions: ["6.15.0", "6.x (may differ)"]
---

**You’re viewing outdated documentation.** [View the latest Customer’s Canvas On-Premises documentation](https://customerscanvas.com/docs/on-premises/).

# 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](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.htm.md) 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](https://customerscanvas.com/docs/cc6/IframeApi-introduction.htm.md) topic.
 
## Modules
  
|  Name |  Description |
| --- | --- |
 |  [BaseEditor](https://customerscanvas.com/docs/cc6/customerscanvas.baseeditor.htm.md) |  The module containing basic widget interfaces. |
 |  [IframeApi](https://customerscanvas.com/docs/cc6/customerscanvas.iframeapi.htm.md) |  The Iframe Api module. It provides data and methods for a product handling. |