Manage app settings

United States
Canada
Europe
Latin America

You can use the following information to set up a new app or edit the settings of an existing app.

Access settings for your app

  1. Log in to your sandbox Developer Dashboard.
  2. From the left navigation menu, click Your Apps > App name > App Settings. The App name - App Settings page lets you view and configure settings and permissions that your app requires to access Clover merchant data.
  3. On the App Settings page, review or edit information in the fields.
2358

App settings page

Edit the App Name

  1. Complete steps to access settings for your app.
  2. From the left navigation menu, click Market Listing. The App name - Market Listing page appears.
2354

Market Listing page

  1. Click the app name. The Edit App Name and Icon window appears.
1172

Edit App Name and Icon pop-up

  1. In the App Name field, enter the new app name. You can also upload an image file as the app icon.
  2. Click Save.

View App ID and App Secret

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—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 lets you access merchant data.
  • For Android apps—Use the app ID and secret to generate an API token. You can use the API token to query web services using Clover Android SDK.

Select App Type

App Type indicates whether you are building an Android app, web app, or a semi-integration with Clover devices. You can build apps for:

You can select multiple app types, based on the solution you are building for Clover merchant.

  1. Complete steps to access settings for your app.
  2. Click App Type. The App Type page appears.
App Type page

App Type page

  1. Select an app type:
  • Android app—Select Clover devices only if you want your Android app to run on the Clover device. After you click Save, the App Settings page displays the Android APKs field. Use the field to upload and manage your Android APKs. For more information, see Manage Android app releases.
  • Web app—In the REST Clients section, click Web. After you click Save, the REST Configuration field displays on the App Settings page. See Add web app settings.
  • Semi-integrated app— For - Is this app an integration of an existing point of sale? option - select Yes. After you click Save, the App Settings—App Type section displays a Remote App ID (RAID) that uniquely identifies your semi-integrated app. For more information, see Create your Remote App ID.
1248

App Settings page

Edit Requested Permissions

Define the app permissions for customers, employees, merchants, inventory, orders, payments, and ecommerce. If you change app permissions after a merchant (including your test merchant) downloads your app, the new permissions don’t take effect until the merchant uninstalls and reinstalls the app. For more information on app permissions, see Set app permissions.

  1. Complete steps to access settings for your app.
  2. Click Requested Permissions. The Edit Requested Permission page appears.
1714

Requested Permissions page

  1. Review or edit information on the page.
    Note: If you select the Enable online payments checkbox in the Ecommerce section, the Ecommerce Settings section displays on the App Settings page. See Enable online payments for Ecommerce.
  2. Click Save to save any edits.

Use webhooks

Webhooks allow your app to receive notifications when merchants who have installed your app perform certain actions. For example, if a merchant has granted you READ_INVENTORY permission and changes their inventory, you'll receive a POST request to the specified for updating the inventory. For more information, see Use webhooks.

Set Merchant Availability

Each Clover merchant subscribes to a software-as-a-service (SaaS) plan per their business needs. These SaaS plans provide merchants with access to specific modules or categories of functionality available in each merchant SaaS plan on the Clover platform. Clover recommends you select only the modules that apply to your app using the Merchant Availability setting. For more information, see Set modules for merchant plans.

Set Receipt Customizations

Smart receipts allow you to add information to Clover paper and web receipts for the customer. For more information, see Customize receipts.

Add web app settings

  1. Select Web app on the App Type page. The REST Configuration displays on the App Settings page.
    See Select App Type.
  1. Click REST Configuration. The Edit REST Configuration page appears.
1722

REST Configuration page

  1. Enter information in the fields:
    • Site URL field—Link (URL) of your web app homepage.
    • Alternate Launch Path (optional)—Link (URL) of the home page of your web app. This URL uses the expiring authentication tokens to authenticate with APIs.
    • CORS Domain (optional)—If you are integrating with Cloud Pay Display, enter a domain link (URL). When you set 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 Set app URL and CORS.
  1. In the Default OAuth Response field, select an option:
  • Code—Default. When your test merchant is authorized through 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. See Generate an API token.
  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 display on the App Settings page.

Enable online payments for Ecommerce (card-not-present) transactions

  1. Complete steps to access settings for your app.
  2. Click Requested Permissions. The Edit Requested Permission page appears.
1764

Requested Permissions page

  1. In the Ecommerce section, select the Enable online payments checkbox. The Ecommerce Settings section displays on the App Settings page.
1116

App Settings page

  1. Click Ecommerce Settings. The Edit Ecommerce Setting page appears.
1730

Ecommerce settings

  1. Select an option:
  • Hosted iFrame—Use the Clover-hosted iframe to integrate secure payment features on your website. See Clover iframe integrations.
    When you use the hosted iframe, the Use reCAPTCHA for all transactions made through the iFrame embedded page appears. reCAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) test blocks automated software attacks and prevents transaction spamming. Clover requires all hosted iFrame pages to be protected by reCaptcha and recommends turning on the reCAPTCHA setting. You can also integrate your own reCAPTCHA test.
    See Clover Ecommerce vs. Bots: reCAPTCHA Your Website to learn more about implementing CAPTCHA as a security feature in your Ecommerce integration.
  • Hosted Checkout—Take payments on the merchant website with Clover. See Hosted Checkout API.
  1. Click Save. The selected integration type displays on the App Settings page.