Web Apps

Web apps for Clover Merchants

A Clover web app is a browser-based integration that uses our REST API utilizing OAuth to create a secure connection to your web app. Web apps redirect a merchant from the Clover dashboard to a developer’s URL. Clover web apps offer a seamless experience that enables merchants to connect services through a central hub.

Clover web apps create an alternate integration path for scenarios where a native, on-device experience may not be appropriate. Clover developers have used our OAuth protocol for reporting, analytics, e-commerce integrations, etc.

Before you begin: Sandbox vs. Production

Clover maintains separate production servers for different market regions (US and EU Production). In addition, Clover provides a Sandbox server which is used for development and testing, and allows the use of Developer Kits.

If you are new to Clover, you should begin by creating your sandbox developer account. Create a developer account at the Developer Dashboard. Verify your email address and test merchant account.

Step 1. Create your Clover web app

Go to the Developer Dashboard and click on your developer name in the top right of the screen to display all the merchants associated with your account, as well as to create additional merchants. This is also how you switch between test merchant accounts.

getting-started-5

From the main developer page, you should see see a green button near the top that says Create New App. Click this to the create an app and enter your app’s information.

Note

When your app has been added by an associated developer account, including your test merchant account, the app cannot be deleted and new apps cannot use the same name.

getting-started-6

 

Step 2. Register your Web App’s URL

For web-based applications Clover uses OAuth 2.0. This provides you with a mechanism to get an API token for a particular merchant.

If you are building an Android app for Clover devices which is simply a web view, you can get an access token from the Clover SDK. Please note these changes to Android SDK auth token generation: https://docs.clover.com/announcements/changes-to-android-sdk-auth-token-generation/.

If you are building an Android app that will run on non-Clover devices, see this Android OAuth example.

In order to use OAuth, you need to configure your app’s Domain and Site URL by clicking Edit App from the Developer Dashboard.

getting-started-9

Site URL

This url is where merchants will be redirected after both installing your app and launching it from the merchant dashboard. It will also be where merchants land after you redirect to /oauth/authorize and the merchant authenticates by logging in and/or selecting their merchant account as needed. You can override the post-authorization landing page by supplying a redirect_uri in your request to /oauth/authorize.

NOTE

A redirect_uri passed to /oauth/authorizemust be a subpath of the selected Site URL. For example, if you specify a Site URL ofhttps://www.example.com/myapp, then in your OAuth request a redirect_uri of https://www.example.com/myapp/setup is valid, but https://example.com/setup is not valid.

CORS Domain

Enter your application domain such as https://www.example.com (or http://localhost:8000for testing). The access token provided by the OAuth flow can be used for Cross Domain requests as long as they originate from this domain.

Step 3. Add Pricing Option(s)

An app requires at least one pricing option before merchants, including your own test merchants, can install and launch the app. From the Developer Dashboard, click on the Edit Pricing link to launch and complete this step.

Step 4. Edit any relevant app settings

From the Edit App Page, you can also upload an icon for your app, set the permissions related to merchant data and/or services, declare your privacy policy, and more. Declare the permissions you need here; this will set the Clover APIs your app is authorized to use.

Step 5. Test the debug version of your app

When you’ve finished developing your app, you can test as if you were a merchant installing and launching the app via the App Market. Click the Preview in App Market link.

Note

Only merchant accounts that were created with your developer account will be able to see your app in the App Market without it first being published.

 

Click Install. Note that any permissions you have set are shown here for the merchant to accept, as well as any subscription levels. You can view subscription information through our REST API.

You will then be redirected to your app’s activation URL with the appropriate merchant ID and auth code. Use these query parameters for the Clover OAuth flow to access the merchant’s data. For more information on OAuth, please see the OAuth page.