Clover Platform Docs

Managing app settings

Click App Settings on the side-nav to view and configure required settings and permissions that your app requires for accessing Clover merchant data.

App Name

Enter a name when you create a new app on the Developer Dashboard. To change the app name later, do the following:

  1. Click Your Apps.
  2. Select the app you want to rename.
  3. Click Market Listing.
  4. Click the edit icon next to the app name.
  5. In the Edit App Name and Icon window, enter the new app name.
  6. Click Save.

App ID & App Secret

The App ID and App Secret values uniquely identify your app on the Clover platform. These values are required for you to make authorized and authenticated requests to Clover merchant data.

For web apps, you use the app ID and secret in the Clover OAuth 2.0 flow to retrieve an API token for permissions granted by a Clover merchant. The API token enables you to access merchant data.

For Android apps, you can use the app ID and secret to simply generate an API token and then to query web services using Clover Android SDK.

App Type

With App Type, you can specify whether you are building an Android app, web app, or a semi-integration with Clover devices. Based on the solution you are building for Clover merchants, you can select multiple app types. Clover provides these App Types:

  • App Market or Public
  • Semi-Integrated
  • Clover Go
  • Private or Merchant-specific

๐Ÿ“˜

NOTE

A semi-integration with a Clover device is where a 3rd party POS system uses Clover for processing payments. For more information, see Clover development basics for semi-integrations.

On the App Type modal, set your app type, and then click Save:

  • Android app: Select the Clover devices that you want your Android app to be supported on.
  • Web app: Under REST Clients, click Web.
  • Semi-integrated app:
    1. In response to the Is this app an integration of an existing point of sale? question, click Yes.
    2. Click the GENERATE RAID button that appears. A Remote App ID (RAID) is generated that uniquely identifies your semi-integrated app. For more information, see Remote App ID.

Additional settings based on app type

๐Ÿ“˜

NOTE

App permission settings are discussed separately in Setting app permissions.

After you set the type of app you are building under App Type, additional settings appear on the App Settings page.

Android apps

On the App Settings page, click Android APKs to upload and manage your Android APKs. For more information, see Managing app releases.

Web apps

To complete additional settings for your web app:

  1. On the App Settings page, click REST Configuration.
  2. On the Edit REST Configuration modal that appears, set the Site URL value as the landing page URL of your web app.
  3. Optionally, set the CORS Domain value. By setting a CORS domain URL, your web app can make calls to the Clover REST API without requiring an intermediate app server. For more information, see Setting app URL & CORS.
  4. Under DEFAULT OAUTH RESPONSE, set the following configuration:
  • Code: This is the default value. When your test merchant is authorized via OAuth 2.0, you receive an authorization code. This code is required for you to request an API token for your app permissions.
  • Token: When your test merchant is authorized, you directly receive an API token for your app permissions. Generate an API token on the Merchant Dashboard.
  1. Click Example OAuth Request to view a sample OAuth request and response in your browser address bar. Both the request and response is based on the Site URL value.
  2. Click Save. The updated values appear on the App Settings page.

โ—๏ธ

WARNING

Tokens generated on the Merchant Dashboard should only be used when testing the API in sandbox. Using these merchant tokens in production is forbidden.

Webhooks

For merchants that have installed your app, this section enables your app to subscribe to certain merchant actions. For more information, see Using Webhooks.

Semi-integrated apps

You can view the automatically-generated RAID for your semi-integrated app in the App Type section on the App Settings page. For more information, see Your Remote App ID.

The remaining sections of your appโ€™s Settings page are described in the next few topics.

Updated about a month ago


Managing app settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.