Back to top

Install the SDK

Download the SDK

  1. Sign in to the Knox Developer Portal. If you’re not already a member of the Knox Partner Program, Become a Partner and provide your details.

  2. Click SDK Tools > SDK Downloads.

  3. On the SDK Downloads page, click Download for the SDK you want.

  4. Review the SDK Agreement. If you agree to the terms, select the checkbox and click Accept. The browser saves the SDK package into your Downloads folder.

  5. Extract the contents.

Create your Android Project

  1. Open Android Studio.

  2. Create a new project: click File > New Project.

  3. Fill the fields:

    1. Application name: your app name.

    2. Company Domain: the qualifier for your app package name.

    3. Package name: this is the combination of the company domain and application name, which must be unique across all packages in the Android environment. Android generates this from the application name and company domain values.

    4. Project location: the directory where your app is stored. You can use the default or specify another location.

  4. Click Next.

    New project next button

  5. Select Phone and Tablet as your platform.

  6. Select the API level you want to target.

    Select API level

    • For details about which Android version maps to which Knox SDK versions, see Knox version mapping.
  7. Select your activity type and click Next. For the purpose of this tutorial, select Empty Activity. For more information on Activities, see Android Activities.

    Select activity type

  8. Choose an Activity Name and Layout Name. For the purpose of this tutorial, accept the default Activity Name and Layout Name. Click Finish.

    Select default activity and layout name

For more information on how to create an Android project, see Google’s Create your first Android app.

Add Knox libraries to a project

  1. Open the project in Android Studio.

  2. Use the file browser to navigate to the location where the library files are stored.

  3. For the Knox POS SDK, select the knoxpossdk.jar and then click Copy.

    Copy project

  4. Switch to your Android Studio project, select the libs directory, and paste the libraries into your project. This displays the libraries in your project under the libs directory. If you do not see the libs directory, ensure your file browser is using ‘Project’ view rather than ‘Android’ view. You may have to create this folder yourself.

    libs directory

  5. Click OK to complete copying the libraries into the project. The libraries in your project are displayed in the libs directory.

  6. Select and right-click the library you just copied. Click Add As Library….

  7. Select the module to add the library to, and click OK. If your app contains several modules, ensure that you add the library to the appropriate module. For the purpose of this tutorial, select the app module.

    Select module to add library to

Your project now includes the Knox POS SDK.

Is this page helpful?