Getting Started
Quickstart guide for Android projects using Keyless.
🚀 Lets get started!
🚀
In this Getting Started guide, we will add the Keyless SDK to your Android mobile application project. This will allow you to enroll and authenticate users with the Keyless protocol.
Prerequisites
- Android Studio 3.5 or later
- Your project must target API level 23 or later
- Set up a physical Android device for running your app.
Once you're ready with the prerequisites, let's get started.
👨🔧 Installation
👨🔧
Add the following within the
repositories section of the build.gradle file of your Android application. Replace the YOUR_CLOUDSMITH_TOKEN text with the CloudSmith token for partners provided to you by Keyless:1
allprojects {
2
repositories {
3
google()
4
jcenter()
5
6
maven {
7
url "https://dl.cloudsmith.io/YOUR_CLOUDSMITH_TOKEN/keyless/partners/maven/"
8
}
9
}
10
}
Copied!
Add the following to the
dependencies block of your project build.gradle file (typically app/build.gradle):app/build.gradle
1
dependencies {
2
// ...
3
4
implementation 'io.keyless:keyless-sdk:+'
5
}
Copied!
Add the following to the
android block of the same file:app/build.gradle
1
android {
2
// ...
3
4
aaptOptions {
5
noCompress "tflite"
6
}
7
compileOptions {
8
sourceCompatibility JavaVersion.VERSION_1_8
9
targetCompatibility JavaVersion.VERSION_1_8
10
}
11
12
// add the following only if you're using Kotlin
13
kotlinOptions {
14
jvmTarget = "1.8"
15
}
16
}
Copied!
🛸 Implementation
🛸
The final step is to prepare your application to interact with the Keyless SDK. To do this, first create a new Kotlin class that will implement the methods of the
KeylessDelegate used by the Keyless SDK to communicate progress back to your application. Through this quickstart, we will implement the application login within the methods of this delegate.1
// Mandatory methods
2
3
fun enrollmentFinish(
4
keylessID: String?,
5
enrollmentResponse: String?,
6
error: KeylessException?
7
)
8
fun authenticationFinish(token: String?, error: AuthenticationFailed?)
9
fun deEnrollmentFinish(deEnrollmentResponse: String?, error: DeEnrollmentFailed?)
10
11
// Optional methods
12
13
fun authenticationStart()
14
fun deEnrollmentStart()
15
fun enrollmentProgress(progress: Float)
16
fun enrollmentStart()
Copied!
An example implementation of a
KeylessDelegateCustom class is here.KeylessDelegateCustom.kt
1
import android.util.Log
2
import io.keyless.sdk.api.AuthenticationFailed
3
import io.keyless.sdk.api.DeEnrollmentFailed
4
import io.keyless.sdk.api.KeylessDelegate
5
import io.keyless.sdk.api.KeylessException
6
7
class KeylessDelegateCustom : KeylessDelegate {
8
9
private var TAG = "KEYLESS_DELEGATE"
10
11
// Mandatory methods
12
13
override fun authenticationFinish(token: String?, error: AuthenticationFailed?) {
14
if (error != null) {
15
Log.e(TAG, "Authentication failed: " + error.message)
16
return
17
}
18
19
// Handle successful authentication
20
}
21
22
override fun deEnrollmentFinish(deEnrollmentResponse: String?, error: DeEnrollmentFailed?) {
23
if (error != null) {
24
Log.e(TAG, "DeEnrollment failed: " + error.message)
25
return
26
}
27
28
// Handle successful de-enrollment
29
}
30
31
override fun enrollmentFinish(
32
keylessID: String?,
33
enrollmentResponse: String?,
34
error: KeylessException?
35
) {
36
if (error != null) {
37
Log.e(TAG, "Enrollment failed: " + error.message)
38
return
39
}
40
41
// Handle successful enrollment
42
}
43
44
// Optional methods
45
46
override fun authenticationStart() {
47
super.authenticationStart()
48
Log.i(TAG, "Authentication started.")
49
}
50
51
override fun deEnrollmentStart() {
52
super.deEnrollmentStart()
53
Log.i(TAG, "DeEnrollment started.")
54
}
55
56
override fun enrollmentProgress(progress: Float) {
57
super.enrollmentProgress(progress)
58
Log.i(TAG, "Enrollment progress: $progress.")
59
}
60
61
override fun enrollmentStart() {
62
super.enrollmentStart()
63
Log.i(TAG, "Enrollment started.")
64
}
65
}
Copied!
📱 Initialisation
📱
Now you are ready to interact with the Keyless SDK from your
Activity.Import the Keyless SDK module:
1
import io.keyless.sdk.api.Keyless
Copied!
Configure the
Keyless class, typically in your Application’s onCreate method, or in onCreate of any Activity. Pass in YOUR_KEYLESS_API_KEY and the class that will conform to KeylessDelegate the KeylessDelegate protocol (for instance, the KeylessDelegateCustom class you created before).1
private var delegate = KeylessDelegateCustom()
2
3
override fun onCreate(savedInstanceState: Bundle) {
4
super.onCreate(savedInstanceState)
5
6
try {
7
Keyless.configure(this, "YOUR_KEYLESS_API_KEY", delegate, 0)
8
} catch (e: Exception) {
9
e.printStackTrace()
10
}
11
}
Copied!
Example implementation:
1
package io.keyless.keylesssdkintegration
2
3
import androidx.appcompat.app.AppCompatActivity
4
import android.os.Bundle
5
6
import io.keyless.sdk.api.Keyless
7
8
class MainActivity : AppCompatActivity() {
9
private var delegate = KeylessDelegateCustom()
10
11
override fun onCreate(savedInstanceState: Bundle?) {
12
super.onCreate(savedInstanceState)
13
14
try {
15
Keyless.configure(
16
this, "YOUR_KEYLESS_API_KEY",
17
delegate, 0
18
)
19
} catch (e: Exception) {
20
e.printStackTrace()
21
}
22
23
setContentView(R.layout.activity_main)
24
25
}
26
}
Copied!
Last modified 1yr ago
Export as PDF
Copy link