Android apps

NOTE

If this is your first time building an Android app for Clover, you can try our Android App Tutorial first.

Download the Clover APKs

  1. Using either an Android emulator or an Android device, install Clover Services and add a Clover account. You can find Clover Services on the Development APKs page. You may want to view the step-by-step video tutorial on setting up your Android device for development purposes.
  2. Download and install Clover and App Updater onto your Android device.
  3. Navigate to your device’s Settings menu and select Add Account.
  4. Select Clover from the list.
  5. Log in using the Clover Developer account you just created. Your device will then prompt you to install the latest Clover system apps.
  6. When prompted to pick a home app, select the Clover Launcher.
    getting-started-4
  7. Afterwards, visit the Clover App Market to download additional apps such as Inventory and Tables.

Create your Clover app on the Developer Dashboard

  1. In the Developer Dashboard, click on your developer name at the top right of the screen. This will display all of the merchants associated with your account.getting-started-5
  2. Click the Create New App button near the top of the main developer page to begin creating a Clover app.
  3. Enter the name of your app.
  4. Click the Create button. This will take you to the Edit App page.

IMPORTANT

Once your app has been created on the Developer Dashboard and added by any merchant account(s) (including your own test merchant accounts), it is no longer possible to delete that app.

Selection_690

Upload your first APK

Before you can test your app, you must upload an APK to install on your test device.

  1. First, expand the App Type > Android app for Clover devices heading on the Edit App page. 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.

    IMPORTANT

    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.

    Selection_688

  2. Next, click the Manage APKs button.

    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.

    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.

    NOTE

    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, make sure to use cert as the value for the  -alias argument to the keytool command when generating your private key. The alias_name argument to the jarsigner command must use the same value.

  3. Select Choose File, then locate the APK you wish to upload. Finally, click the Upload New APK button to upload the APK as a version of your app.Selection_689You can install/reinstall your app on your test device once your APK is uploaded, and all of the app’s permissions will be set. You may sideload over your app from this point on, and the permissions will remain intact. Note that any app with an uploaded APK must have the APK approved by Clover before it can be published.

Edit any relevant app settings

From the Edit App page, you will also be able to upload an icon for your app, set the permissions related to merchant data and/or services, declare your privacy policy, and more. Declare the permissions you need here; this will set the Clover APIs your app is authorized to use.

Add pricing options

An app requires at least one pricing option before merchants will be able to install and launch the app (including your own test merchants). From the Developer Dashboard, click on the Edit Pricing link to launch and complete this step.

Sideload your APK

Use adb install to sideload your APK onto your development device. You can now use any of the Clover Services, or use the access token from the Account Authenticator to make Web API requests.

Test the debug version of your app

When you’ve finished developing your app, click on the Clover App Market Preview link to test how it appears in the Clover App Market.

NOTE

The only merchant accounts that will be able to see your unpublished app in the Clover App Market are the ones that were created under your developer account.

getting-started-12

getting-started-8

Select your app, then click Install App. Note that any permissions you have set are shown here for the merchant to accept, as well as any subscription levels. Your app will now be able to access this merchant’s data, as well as receive their subscription information.