App Bridge from npm

By default, all new apps are embedded in the Shopify admin. You can embed an existing app with the following steps:

1. From your Partner Dashboard, click Apps.
2. Click the name of your app.
3. Click Configuration.
4. In the Embedded in Shopify admin section, set the value for Embed app in Shopify admin to True.
5. If you plan to embed your app in Shopify POS, then, in the POS section, set the value for Embed app in Shopify POS to True.
6. Click Save and release.

You must serve your embedded applications over HTTPS.

The Shopify admin uses HTTPS for all pages. Failure to serve an embedded app over HTTPS will cause errors in web browsers, due to mixed content restrictions.

Learn more about serving your app over HTTPS.

The Content Security Policy frame-ancestors directive controls where the app can be framed. You must ensure your app is only frameable by the authenticated shop domain and the admin domain to avoid clickjacking attacks.

You can do this with the Content Security Policy frame-ancestors directive:

Learn more about the frame-ancestors directive and app security.

Embedded apps should use token exchange to obtain an access token. Depending on your needs, you can request an online or offline access token.

Shopify App Bridge 3 is available as a JavaScript module on npm. You can install it in your app using npm or yarn.

To keep your embedded apps secure, you need to specify the following configuration values, when intializing App Bridge:

• apiKey - The client ID provided for your application in the Partner Dashboard.
• host - The host of the specific shop that's embedding your app. This value is provided by Shopify as a URL query parameter that's appended to your application URL when your app is loaded inside the Shopify admin.
• forceRedirect (Optional) - If set to true, then App Bridge detects when your app is loaded outside of the Shopify admin, and automatically redirects the user to the Shopify admin page that embeds your app.

The following example uses ResourcePicker to open a UI component that enables users to browse, find, and select products from their store using a familiar experience.

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.