Quickstart guide

Succinct steps to get your Sees360 integration up and running.

Setup a project

  1. Go to the Projects screen and click “Add New Project”
  2. Complete the Name and Package name (com.example.app) fields
  3. Generate a new API token, giving it a descriptive name e.g. “Staging API key”

Copy the API key immediately as you will not be shown this key again!

Install the SDK into your app

  1. Visit the Accounts screen
  2. Generate a token to access the Maven repo for Sees360, this token will be valid for 12 hours
  3. Follow the onscreen instructions to install the SDK into your app
  4. Initialise the SDK in your app
// applicationContext - The App context
// apiKey - The API key when setting up the project, stored here in BuildConfig
// identifier - The unique identifier for your customer as a UUID
val apiKey = BuildConfig.API_KEY
Sees360.initialize(applicationContext, apiKey, identifier)

Ensure the customer has granted the PACKAGE_USAGE_STATS permission before initialising the SDK, if not granted SDK will not collect/send data.

Permissions

The SDK needs permission to access the following data sets:

  • INTERNET — install-time permission
  • PACKAGE_USAGE_STATS — required special permission
  • ACCESS_COARSE_LOCATION — optional runtime permission
  • ACCESS_FINE_LOCATION — optional runtime permission

Accessing the UsageStatsManager requires the special permission android.permission.PACKAGE_USAGE_STATS, which the customer must grant via their device settings — it is not runtime-grantable like location/camera etc. We recommend initializing the SDK only after this permission has been granted.

The INTERNET permission is an install-time permission — the customer does not need to be prompted for access; it’s simply displayed in the app store listing.

The location permissions are completely optional. The SDK checks for fine location access first, then coarse location. If no location information can be accessed, none is recorded.


This site uses Just the Docs, a documentation theme for Jekyll.