Skip to main content

Types of apps

Version 1.0.0

Apps play an important role within Haravan’s ecosystem. This guide explains the different types of apps you can build. It also describes how merchants and developers manage apps.

What type of app should I build?

The type of app you choose to build depends on its purpose and how you’ll distribute or sell it. You can't change the type of app after you create it, so make sure that you understand the different capabilities and requirements of each type.

You can build the following types of apps:

Public app: An app that you can distribute to many merchants.

Private app: An app that is tailored for merchants with specific requirements not met by a custom app.

Capabilities and requirements

The following table shows the capabilities and requirements that are associated with each type of app:

Type of appAuthentication methodInstallationDistribution in App StoreFeatures and limitations
PublicOAuth. If embedded, then OAuth and session tokens.Installed on multiple Haravan storesYesCan use Haravan App-sdk to display as an embedded app.
Can use app extensions.
PrivatePrivate app authenticationInstalled on a single Haravan storeNoCan't use Haravan App-sdk to display as an embedded app.
Can't use app extensions.

Embedded apps

Embedded apps enable you to add features to certain parts of Haravan’s user interface and online stores.

Embedded apps are hosted on your own infrastructure, integrate with Haravan using Haravan App-sdk, and display directly in the Haravan admin inside an iframe.

Standalone App (Alternatives to embedded apps)

We recommend building embedded apps because they deliver the best merchant experience and are closely integrated with Haravan.

However, you can build a standalone app, which isn't embedded in the Haravan admin. Standalone apps expose their own user interface, on their own web domain.

How merchants manage apps

Merchants manage apps by installing them in the Haravan admin, which authorizes Haravan to share certain data with that app. Installation varies for public, and private apps.

Installing public apps

Public apps are installed using OAuth. During installation, a URL is displayed to the merchant to request specific API access scopes. If the merchant grants the requested access, then the app can be installed.

The installation process can be initiated with any web link. However, listing in the Haravan App Store is the best way to reach the greatest number of potential customers.

Installing private apps

Private apps use HTTP authentication with credentials generated by a single store. If the app has a valid credentials for that store, then it has access to the store’s data.

Private apps are managed from the merchant's Haravan admin.

Uninstalling apps

Merchants can delete apps from their stores at any time. Deleting an app revokes API access tokens for that store, stops subscription webhook, and generates an uninstall webhook. Uninstall events also occur when a Haravan store using an app is closed or suspended.

How developers manage apps

Partner Dashboard: Create and manage your public and private apps, collaborate with development teams, and track app installations and revenue. To log in to your account or to sign up for a new account, visit Haravan Partners.

Development stores: Test any apps that you create.

API libraries: Use Haravan's official libraries to interact with the Omni API. You can also access third-party Omni API libraries that are maintained by members of the Haravan community.

App-sdk: Streamline embedding an app in the Haravan admin using Haravan's JavaScript library.