Android Installation

Overview

Before adding Senisbill dependencies to your project, please ensure you’ve added the Sensibill Maven server as a dependency repository in your project build.gradle file, as explained below.

Adding Sensibill Maven Server

The primary method of installing the SDK is via Sensibill’s private maven server. All stable SDK artifacts are stored on a private maven server than can only be accessed using an authorized username and password. Contact Sensibill’s Client Services to get a username and password. Once you have maven credentials, one of the two following changes to your gradle configuration will allow you to import Sensibill SDK dependencies.

// (old gradle style) IF Maven repositories are listed in the project level `build.gradle`
// file, Sensibill's Maven server should be added to the `allprojects.repositories` block
allprojects {
    repositories {
        // Other Maven Servers ...

        maven {
            // Sensibill SDK repository
            url 'https://maven.pkg.github.com/getsensibill/sdk-android'
            credentials {
                username 'to be provided by sensibill'
                password 'to be provided by sensibill'
            }
        }
    }
}

// (new gradle style) IF Maven repositories are listed in the `settings.gradle` file,
// Sensibill's Maven server should be added in the `dependencyResolutionManagement.repositories` block
dependencyResolutionManagement {
    repositories {
        // Other Maven Servers ...

        maven {
            // Sensibill SDK repository
            url 'https://maven.pkg.github.com/getsensibill/sdk-android'
            credentials {
                username 'to be provided by sensibill'
                password 'to be provided by sensibill'
            }
        }
    }
}

Adding Sensibill Gradle Dependencies

Once you have access to Sensibill Artifacts, adding the SDK to your project is a matter of adding the correct dependencies to your app level build.gradle file.

Info

For each of the dependencies listed below, please replace X.X.X with the desired Sensibill SDK version

For Full SDK functionality, add:

implementation "com.getsensibill:sensibill-sdk-all:X.X.X"

For Standalone Capture, add:

implementation "com.getsensibill:sensibill-capture-standalone:X.X.X"

Headless SDK, add

implementation "com.getsensibill:sensibill-sdk-core:X.X.X"

Headless SDK + Capture Flow, add

implementation "com.getsensibill:sensibill-capture-flow:X.X.X"

If using Username/Password Authentication, add in addition to other modules:

implementation "com.getsensibill:sensibill-auth:X.X.X"
implementation "com.getsensibill:sensibill-oauth-client:X.X.X"