Platform Docs

Uploading & testing APKs

Uploading your first APK

Before you can test your app, you must upload an APK to install on your Clover Dev Kit or Emulator.

  1. On the sandbox Developer Dashboard, click App Releases on the side-nav for your app.

IMPORTANT

The first APK you upload will set the package name for your app. This is the same as the package attribute in your AndroidManifest.xml file.

Once you upload an APK, the package name for your app cannot be changed. Check the package attribute in your manifest file carefully before uploading your first APK.

  1. On the App Releases page, click UPLOAD APK.

IMPORTANT

Make sure your APK meets the following requirements before attempting to upload it:

  • The package name does not begin with com.clover. (this indicates an app owned by Clover).
  • The android:minSdkVersion attribute in your AndroidManifest.xml has a value of 17 or less.
  • The android:versionCode attribute in your AndroidManifest.xml is greater than the version code of any APK you've already uploaded.
  • The APK is signed with the same key you used to sign the first APK you uploaded.
  • The APK is signed in release mode.
  • The APK is signed with only the V1 signature scheme (Jar Signature). The V2 signature scheme is not supported.
  • The signature file is saved as META-INF/CERT.RSA.
  • The size of the APK file does not exceed 50 MB.

NOTE

Keep your keystore and private key in a safe and secure place, and make sure to back them up. If you create an Android app on Clover and then lose the key you used to sign its initial APK, you will not be able to upload any new versions of your app, since you must always sign all versions of your app with the same key.

If you are using the Generate Signed APK Wizard in Android Studio to sign your app, the signature file will automatically be saved as META-INF/CERT.RSA. If you are signing your app manually, ensure that you set the -alias argument as cert for the keytool command when generating your private key.

The alias_name argument for the jarsigner command must use the same value.

  1. On the New Public Release modal that appears, click CHOOSE APK and select an APK you want to upload.
  2. Click Upload. The uploaded APK is available in the Releases table.

You can install/reinstall your app on your Clover Dev Kit (or Emulator) once your APK is uploaded with your app permissions set. You can sideload your app from this point on, and the permissions remain intact.

NTOE

In the sandbox environment, any uploaded APKs are automatically approved.

On the production Developer Dashboard, an uploaded APK must have the APK approved by Clover before it can be published. For more information, see Submitting apps.

Sideloading your APK

Use adb install to sideload your APK onto your Clover Dev Kit or Emulator.

  1. In Android Studio, select View > Tool Windows > Terminal (Alt+F12/Option+F12).
  2. To verify that ADB is connected to your Clover Dev Kit or Emulator, run the following command: adb devices.
  3. To install your app, run adb install {download_folder}/com.your.package.name.here.apk. A Success message appears in the terminal.

NOTE

The next time you sideload your app, open a Clover app on your Dev Kit or Emulator and then click the sync button at the top-left of the app. This ensures that you have the latest version of your sideloaded app on the Dev Kit or Emulator.

Testing & debugging a version of your app

To test and debug your Android app:

  1. On the sandbox Developer Dashboard, click Market Listing on the side-nav for your app.
  2. On the Market Listing page, click PREVIEW IN APP MARKET. You are redirected to the Merchant Dashboard where you view a snapshot of what merchants and business owners see on the Clover App Market.
  3. Click Connect. When you accept the installation, the app is installed for your test merchant on the Clover Dev Kit or Emulator.

NOTE

You view your app in the App Market preview only for your test merchant accounts.

Any permissions you have set for your app are shown on the App Market preview page, as well as any subscription levels.


Uploading & testing APKs


Suggested Edits are limited on API Reference Pages

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