Application proxies

You can use an application proxy to fetch data from an outside location and display it on the page of an online store. For app developers, this means that the content on these proxy pages can be dynamic, which means that it can be updated as often as you want. Application proxies are useful for displaying image galleries, statistics, custom forms, and other kinds of dynamic content.

You don't need to set up application proxies before you publish your app. If you add an application proxy to an app after you've published it, then existing installations of the app will be updated automatically

Application proxies also support responses from the Proxy URL using Liquid, Shopify's theme customization engine. You can use Liquid to display your proxy page as if it were a part of an online store's theme.

Add a proxy to your app

To add a proxy to your app:

  1. From your Partner Dashboard, click Apps.
  2. Click on the name of the app that you want to change.
  3. Click Extensions.
  4. In the App proxy section, click Add proxy.
  5. Select a prefix from the Sub path prefix drop-down list. If you want to add a sub path as well, then enter one in the Sub path field:

    App proxy settings
    These settings determine which HTTP requests to Shopify are proxied to the Proxy URL that you enter in the next step. For example, if the Sub path prefix is apps, and the Sub path is store-pickup, then any path in your shop after https://your-store.myshopify.com/apps/store-pickup will be proxied to the Proxy URL that you enter in the next step.

  6. Enter the URL of your proxy server in the Proxy URL field. This is the URL that will be proxied from the path that you entered in the previous step.

  1. When you're done, click Save.

Example

Consider the following app proxy configuration:

  • Sub path prefix: apps
  • Sub path: my-app-proxy
  • Proxy URL: https://my-app-proxy.com/app_proxy

In this example, https://example-store.myshopify.com/apps/my-app-proxy/app_path will be forwarded to the Proxy URL at https://my-app-proxy.com/app_proxy/app_path.

What the store owner sees

After a merchant installs an app with a proxy, they can change the sub path. The sub path is where the application proxy will be accessed from a merchant's own shop. Merchants may choose to change the sub path so that the URL in a browser's location bar makes the proxy page look like it's hosted in their store instead of externally. Ultimately, the sub path doesn't affect the actual location of the proxy URL.