Usage

Register Activity Request for Result#

Before initializing the SDK, an activity must be defined to receive the result. For this purpose, use the registerForActivityResult method with the AmparoIdResultContract contract which will be used to launch the SDK. The following code snippet shows how to register

private val amparoLauncher = registerForActivityResult(AmparoIdResultContract()) { result ->
    when (result) {
        AmparoIdSdkResponse.SUCCESS -> onSuccess()
        AmparoIdSdkResponse.CANCELLED  -> onCancelled()
        else -> onFailure()
    }
}

Where onSuccess(), onCancelled(), and onFailure() are methods defined by you to be executed when the SDK returns a success, cancellation, or failure response, respectively.

The AmparoIdSdkResponse enum contains the possible responses from the SDK:

• SUCCESS: the SDK returned a successful response.
• CANCELLED: the SDK was cancelled.
• FAILURE: the SDK returned a failure response.

When SUCCESS is returned, the identification result must be checked by your backend.

Creating SDK Configuration#

The following parameters are required for SDK configuration:

• API_KEY: key for API endpoint consumption.
• API_URL: API base url.
• E_CERT: security certificate used by the SDK.
• KSM_KEY: SDK security key.
• SKM_KEY: SDK security key.
• CONTACT_SUPPORT: your callback to contact support.
• DEFAULT_COUNTRY: the default country for the SDK, which is CHL (Chile) by default. Support for other countries is available, such as URY (Uruguay).
• NFC_MAX_TRIES: maximum number of NFC reading attempts, which is 3 by default.

To use the Amparo ID SDK, create a configuration using the AmparoIdSdkConfig object as shown below:

val amparoIdSdkConfig = AmparoIdSdkConfig.Builder()
    .setApiKey("API_KEY")
    .setBaseUrl("API_URL")
    .setECert("E_CERT")
    .setKsmKey("KSM_KEY")
    .setSkmKey("SKM_KEY")
    .setContactSupport { /* your callback to contact support */ }
    .setDefaultCountry("URY")
    .setNfcMaxTries(3)
    .build()

This instance will be used when invoking the SDK.

Initializing the SDK#

Obtain an instance of AmparoIdApi:

amparoIdSdk = AmparoIdApiFactory.create()

Call the SDK using the defined launcher:

amparoIdSdk!!.startActivityForResult(this@MainActivity, amparoIdSdkConfig, amparoLauncher)

SDK Customization#

Defining colors#

To customize the SDK colors, define colors in the themes.xml file:

<style name="AppTheme" parent="AmparoIdSdkTheme">
    <item name="amparoIdPrimaryMain">@color/purple_200</item>
    <item name="amparoIdPrimaryLight">@color/purple_500</item>
</style>

With AppTheme as the application theme, the SDK will use the defined colors for amparoIdPrimaryMain and amparoIdPrimaryLight.

Defining texts#

To customize the SDK texts, define strings in the strings.xml file: