Docs
Integrations
Apps
Guide
Types of apps

Types of Apps

The first step when developing an app is deciding which type of app to develop. The two types of apps, single-click and connector, are defined by the method of authentication. Single-click apps use an OAuth Authorization Code Grant flow. Connector apps require store owners to manually generate and configure store API credentials. In addition to the authentication method, apps can differ by visibility.

Single-Click

Single-click apps are the recommended app type. They use OAuth 2.0 Authorization Code Grant (opens in a new tab) (oauth2.net) flow. Users initiate installation by clicking Install.

Install App

The app requests the user to grant permissions associated to scopes configured for the app in the Developer Portal (opens in a new tab):

App Permissions

Once granted, the app can request a permanent access_token for making REST API requests on the user's behalf.

Single-click apps can use App Extensions.

Connector

Connector apps use manual OAuth token creation instead of the single-click app flow. Store owners manually generate store-level API credentials and enter them into the app's configuration. While single-click apps are recommended, the following use cases might not be compatible:

  • Customized integrations that vary per store.
  • Integrations that do not provide any content for an iFrame.
  • Apps that do not provide web services for OAuth exchange (ex: native order sync app).

Visibility

There are three visibility options for apps: Draft, Unlisted, and Public.

VisibilityDescriptionUse Cases
DraftApps registered in the Developer Portal (opens in a new tab) but never submitted for approval
  • Installing on stores owned by the same email address as the Developer Portal (opens in a new tab) account email
  • Testing before submitting an app for review App Marketplace (opens in a new tab)
  • UnlistedApps submitted and approved but not listed on the App Marketplace (opens in a new tab)
  • Installing on stores not owned by same email address as the Developer Portal (opens in a new tab) account email
  • Testing before submitting an app for review App Marketplace (opens in a new tab)
  • PublicApps submitted, approved, and listed on the App Marketplace (opens in a new tab)
  • Making apps visible and installable on all stores
  • Making apps sellable on the App Marketplace (opens in a new tab)
  • Next steps

    Begin app development.

    Resources

    Related articles

    Sample apps

    Tools

    Blog posts

    Did you find what you were looking for?