Integrating with the Shopify admin
Integrating your app into the Shopify admin makes it feel familiar, gives you access to Shopify UI elements, and lets users use it easily on mobile devices.
When you integrate your app, you should design it so that the user isn't forced to leave the Shopify admin on a regular basis. All of its primary functionality should be available within the Shopify admin.
To be properly integrated with the Shopify admin, apps must do the following:
- Keep primary app workflows within Shopify
- Enable seamless sign up based on Shopify credentials
- Include simplified monitoring or reporting
- Keep third-party connection settings within Shopify
Keep primary app workflows within Shopify
Anchor link to section titled "Keep primary app workflows within Shopify"By default, apps should be embedded in the Shopify admin with the latest version of App Bridge. Merchants should be able to complete primary app workflows inside the Shopify admin. Merchants should not need to access an external website or external surface to complete a primary workflow.
| Example | Details |
|---|---|
|
The Search & Discovery app follows this guideline. |
The app includes all workflows, such as customizing filters, search, and recommendations, as pages in the embedded app. 
|
Apps that contain more functionality than can be reasonably integrated into the Shopify admin do not have to integrate all of their primary workflows into the Shopify admin. For example, apps that handle ad buying or enterprise resource planning (ERP) require a standalone site to enable access to their functionality in a user-friendly manner.
However, some workflows must always be present in the Shopify admin. These workflows include setup, configuration, status, dashboards, and other features that help a merchant use the app on a day-to-day basis.
| Example | Details |
|---|---|
|
The Shopify Inbox app follows this guideline. |
The app is a messaging tool that lets app users communicate with customers. Most basic workflows, such as setting up a chat widget, creating automated replies, and configuring notifications are included as pages in the embedded app. 
However, users want to continuously monitor their conversation inbox, and continue to access other areas of the Shopify admin at the same time. Because of this, it's acceptable that the customer conversation workflows in Shopify Inbox are available on an external website. 
|
Enable seamless sign up based on Shopify credentials
Anchor link to section titled "Enable seamless sign up based on Shopify credentials"Apps should make sign up seamless for merchants. Apps should be usable without having an additional login or sign up prompt.
| Example | Details |
|---|---|
|
The Search & Discovery app follows this guideline. |
Users can begin using the app immediately without having to complete another sign up.
|
|
This example app does not follow the guideline. |
This app requires users to complete another sign up before they can use the app. Instead, the app should use the merchant's existing Shopify credentials. This is only acceptable if the app cannot be obtained by merchants in a self-service manner. 
|
Access to some apps cannot be easily obtained by merchants in a self-service manner, and require a more complex sign-up, often involving a business to business contract. Examples of this include connecting to ad networks or allowing non-merchants to log in. These apps are not required to enable seamless sign up using a merchant’s credentials. The first step to the in-admin onboarding of these apps must always be a workflow that enables a merchant to link the current store with their existing credentials.
If your app offers both self-service and business-to-business sign up, then the app's onboarding must include an option to sign up for the service using the merchant's existing Shopify credentials.
Include simplified monitoring or reporting
Anchor link to section titled "Include simplified monitoring or reporting"If your app includes monitoring or complex reports that can only exist on an external website or app surface, then you must include a simplified version of the monitoring or reporting in the Shopify admin.
| Example | Details |
|---|---|
|
The Search & Discovery app follows this guideline. |
The app exposes key metrics about search and recommendation performance, including the click rate and purchase rate, on the app's home page.
|
Keep third-party connection settings within Shopify
Anchor link to section titled "Keep third-party connection settings within Shopify"Any settings or configurations that control the connection between Shopify and a third-party system must be available inside the Shopify embedded app interface.