Getting started with Shopify App Bridge
Embed your app in the Shopify admin
First, create a development store and an app.
By default, new apps are embedded in the Shopify admin. If you need to turn on embedding for an app, follow these steps:
- From your Partner Dashboard, click Apps.
- Click the name of your app.
- From the app overview screen, click App setup.
- In the Embedded app section, click Manage.
- In the Embed your app in Shopify admin section, click Enable.
After you've enabled embedding for an app, Shopify attempts to load your app inside an iframe in the admin.
Embed your app in Shopify POS
First, create a development store and an app.
To embed your app in Shopify POS:
- From your Partner Dashboard, click Apps.
- Click the name of your app.
- From the app overview screen, click App setup.
- In the Embedded app section, click Manage.
- In the Embed your app in Shopify POS section, click Enable.
After you've enabled embedding for an app, your app appears in the Shopify POS mobile app.
To learn more about using your app with Shopify POS, visit our guide on Shopify POS.
HTTPS, SSL certificates, and mixed content restrictions
The Shopify admin uses HTTPS for all pages. Embedded applications also need to use HTTPS.
Failure to use SSL when running an embedded app will cause errors in web browsers, due to mixed content restrictions.
Set the frame-ancestors directive
Shopify apps have the option of setting the frame-ancestors content security policy directive to control where the site can be framed:
The frame-ancestors directive replaces the X-Frame-Options response header and can be used to implement clickjacking protection. To learn more about the frame-ancestors directive, refer to MDN Web Docs.
Set up Shopify App Bridge in your app
Shopify App Bridge is available as a JavaScript module on npm. To install it in your app (to use with bundlers or build systems like webpack), you can use npm or yarn:
or
Shopify App Bridge can also be included directly on a page with a <script> tag pointing to a CDN-hosted copy of the library. Unpkg is an example of a CDN that hosts npm modules.
Authenticate with OAuth
Since embedded applications are loaded inside an iframe, it is critical that the initial OAuth redirect to Shopify occurs at the parent level, escaped from the iframe. Shopify returns the X-Frame-Options=DENY header and prevents any Shopify admin pages from being loaded inside an iframe. Shopify App Bridge provides an action that can be used to perform a redirect within the parent window.
This means that where the OAuth process would normally begin with redirecting the merchant to the authorization prompt, it should instead return a page containing a script which escapes the frame.
Using modular JavaScript
Using ES5 and the CDN-hosted version
What's next?
At the end of the authentication flow, the user will end up at the redirectUri you provided. It's highly recommended that you let App Bridge redirect the user back to Shopify. As part of the initialization process, App Bridge redirects the user if necessary to ensure your app is embedded in the Shopify admin.
Initialize Shopify App Bridge in your app
Once you’ve added Shopify App Bridge to your app, you need to initialize it by passing in your API key and the shop name.
Using modular JavaScript:
Using ES5 and the CDN-hosted version:
The script detects if your app was loaded inside an iframe. If it wasn't, then the script creates a redirection back into the relative embedded URL in the Shopify admin. You can disable this functionality by passing forceRedirect: false as a configuration option.
Set up the Shopify TitleBar
On every page of your app, you should define the behavior of the Shopify TitleBar in relation to your application. For single-page apps (SPAs) you can update the title bar based on your app state. The following example script updates the TitleBar.
Using modular JavaScript:
Using CDN-hosted version:
Next steps
Now that you've initialized your app, you can use any Shopify App Bridge actions.
You can also debug your app with Shopify App Bridge.