Create new app
North America—US and Canada
Latin America—Brazil and Mexico
Global developer platform
On the Global Developer Dashboard, you can access both the sandbox and production environments. Use the Clover sandbox environment to build and test your apps for Clover merchants. When you are ready to launch your private app or publish your app in the Clover App Market get your production developer account and associated app approved.
1. Start initial app setup
- Log in to the Global Developer Dashboard.
- Click the Sandbox toggle icon to go to either the sandbox or the production environment.
- Click Create new app. The Create App window appears.
- Complete the three-step process as follows:
Step 1: Name and country
- In the App Name field, enter a name for your app.
- Select one or more countries where you want to make your app available for Clover merchants.
- Review and select supporting languages for the countries.
- Click Next.
Step 2: App type
- Select the type of app:
- App market app—Public apps that Clover merchants can access through the Clover App Market. This option is available only in the production environment.
- Payment app —App that uses Clover for payment transactions.
- Private app—App that is customized for specific business needs and not published in the Clover App Market.
- Click Next.
Step 3: Platform
- Select the devices to determine your app type, such as Android app or Web app. You can select multiple options for your app.
- Click Create app. The App name - App Settings page displays fields based on the app type and platform you selected. You can continue adding new app information.
2. Complete new app information
On the App name - App Settings page, you can add and manage settings for your app, along with other relevant information.
- Complete information in each of the sections as follows:
S.No. | Section | Description |
---|---|---|
1. | App Settings | When you create a new app, Clover automatically sets a unique App ID and App Secret to identify your app in the Clover platform. You need these values to make authorized and authenticated requests to Clover merchant data. In the App Settings page, fields appear based on the app type and platform you selected during the initial setup. For example, for a semi-integration app, the RAID field displays the remote application identifier. You can complete the following settings on the page: - REST Configuration: Enter site URL and CORS Domain settings for web apps. - Requested Permissions: Select the permissions for customers, employees, merchants, inventory, orders, payments, and eCommerce integrations. Your app requires these permissions to make REST API calls, for example, Read permissions for GET requests and Write permissions for POST/PUT/DELETE requests. You can also select the Enable online payments checkbox for Ecommerce and then select Ecommerce Settings. - Webhooks: Set up a webhooks link (URL) to receive notifications when merchants who have installed your app perform certain events, such as creating an inventory or updating an order. - Merchant Availability: Select the software-as-a-service (SaaS) plan based on the modules your app needs to function. For example, if your app applies discounts to orders based on added items, you need the Orders, Items, and Discounts modules. - Receipt customizations: Set up smart receipts that customers can receive from merchants who have your app installed. |
2. | App Releases | Upload and manage APK versions for your Android apps. |
3. | Pricing & Distribution | Set up pricing tiers for your apps. You can then use the REST API endpoint or the Android AppsConnector method to send metered events to Clover. You need to submit your banking information to start adding paid subscription tiers and metered pricing for your approved app. |
4. | Market Listing | Enter market listing information that displays with your published app on the Clover App Market. |
5. | Installs | View the metrics for billable merchants who have installed or uninstalled your app. The metrics are available for published apps in the Clover App Market with more than 100 installs. This information helps gain deeper insights into your app's adoption by merchants. |
-
Click the X close icon at the top left of any page to return to the Global Developer Dashboard. The app name displays on the Global Developer Dashboard in the My Apps section.
You can test your app and app integrations using the test merchant accounts.
Updated 9 days ago