Migrating from the IFrame SDK

As of March 2024, the Wix IFrame SDK is deprecated and closed to new users. You can access the functionality of the IFrame SDK using the JavaScript SDK (JS SDK) and other Wix APIs. The following tables map popular functions from the IFrame SDK to their alternatives. Alternatives from other Wix APIs will soon be available in the JS SDK as well.

Wix Dashboard

This table maps the functions from the Wix.Dashboard IFrame SDK. All the alternative functions are from the JS SDK unless otherwise noted. Many of the alternative functions in this table are from the Dashboard SDK.

IFrame SDK	Alternative
closeWindow()	closeModal()
getEditorUrl()	getEditorUrls()
openBillingPage()	App Billing Get Url API. This is a REST API that requires configuration in the Wix Developers Center. Learn more about setting up an external pricing page.
openModal()	openModal()
openMediaDialog()	openMediaManager()
pushState()	Use the relativeUrl parameter for navigate() to append segments to a page's URL.
revalidateSession()	This functionality isn't relevant in the JS SDK. Every JS SDK call is signed using a Wix Client.
setHeight()	This functionality isn't relevant for apps using the JS SDK. IFrame heights are set automatically.
getSiteViewUrl()	listPublishedSiteUrls()

Wix Utils

This table maps the functions from the Wix.Utils IFrame SDK. All the alternative functions are from the JS SDK. Many of the alternative functions in this table are from the core SDK module.

IFrame function	Alternative
getInstanceId(), getUid(), getSiteOwnerId(), getSignDate()	Replacements for these functions aren't available yet. During a live IFrame session, the app instance data is available in the instance query parameter in the browser's URL. You can decrypt it to retrieve instanceId, uid, signDate, and siteOwnerId. Learn more about parsing app instance data.
Media.getAudioUrl()	getAudioUrl()
Media.getDocumentUrl()	getDocumentUrl()
Media.getImageUrl()	getImageUrl()
Media.getResizedImageUrl()	Use getScaledToFillImageUrl(), getScaledToFitImageUrl(), and getCroppedImageUrl() as needed.
Media.getSwfUrl()	getVideoUrl()