What's NewAnnouncementsWebinarsCommunityBlog

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 allows you to view and configure settings and permissions that your app requires for accessing Clover merchant data.
  3. On the App Settings page, review or edit information in the fields.
2358

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
  1. Click the app name. The Edit App Name and Icon window appears.
  2. In App Name field, enter the new app name. You can also upload an image file as the app icon.
1172
  1. 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 enables you to access merchant data.
  • For Android apps—Use the app ID and secret to generate an API token and then 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.
1716
  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
  1. Click Save.

Edit Requested Permissions

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
  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.

  1. Click Save to save any edits.

🚧

Important

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.

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 to an endpoint that you specified. For more information, see Use Webhooks.

Set Merchant Availability

Each Clover merchant subscribes to a software as a service (SaaS) plan as 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

To complete additional settings for your web app:

  1. Complete steps to access settings for your app.
  2. Click REST Configuration. The Edit REST Configuration page appears.
1722
  1. In the Site URL field, enter the link (URL) of the home page of your web app.
  2. Optionally, if you are integrating with Cloud Pay Display, enter a domain link (URL) in the CORS Domain field. 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.
  3. 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
  1. In the Ecommerce section, select the Enable online payments checkbox. The Ecommerce Settings section displays on the App Settings page.
1116
  1. Click Ecommerce Settings. The Edit Ecommerce Setting page appears.
1730
  1. Select an option:
  • Hosted iFrame—Use the Clover-hosted iframe to integrate secure payment features on your website. See Clover iframe integrations.
  • 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.

Updated 3 months ago