Installation

This guide will help you install and set up the azakaw Android SDK in your project.

Prerequisites

• Android Studio 4.0 or higher
• Minimum SDK version: API 21 (Android 5.0)
• Compile SDK version: API 33 or higher
• Java 8 or higher

Installation Steps

1. Download the SDK

   Download the latest version of the azakaw Android SDK from our official release: azakaw-android-sdk-release.aar

2. Add the AAR to Your Project

   a. Create a libs directory in your app module if it doesn't exist

   b. Copy the downloaded AAR file to the libs directory

3. Configure Build Settings

   Add the following to your app's build.gradle file. The syntax depends on whether you're using Gradle with Groovy or Kotlin DSL:

   For Gradle Groovy (build.gradle)

   android {
       // ... other configurations ...
   }
   
   dependencies {
       implementation files('libs/azakaw-android-sdk-release.aar')
       
       // Required dependencies
       implementation 'androidx.appcompat:appcompat:1.6.1'
       implementation 'com.google.android.material:material:1.9.0'
       implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
   }

   For Gradle Kotlin DSL (build.gradle.kts)

   android {
       // ... other configurations ...
   }
   
   dependencies {
       implementation(files("libs/azakaw-android-sdk-release.aar"))
       
       // Required dependencies
       implementation("androidx.appcompat:appcompat:1.6.1")
       implementation("com.google.android.material:material:1.9.0")
       implementation("androidx.constraintlayout:constraintlayout:2.1.4")
   }

4. Sync Project

   Click "Sync Now" in Android Studio to synchronize your project with the new configuration.

Basic Usage

To start using the SDK, you'll need to call AzakawKyc.start() with the required parameters:

import com.azakaw.sdk.AzakawKyc
import com.azakaw.uaicasdk.AzakawKycConfig
import com.azakaw.uaicasdk.Environment

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)
        
        // Start the KYC process
        AzakawKyc.start(
            context = this,
            config = AzakawKycConfig(
                sessionId = "your-session-id",
                environment = Environment.SANDBOX,
                isFullscreen = false
            ),
            onCancel = {
                // Handle cancellation
            }
        )
    }

    // Handle permissions
    override fun onRequestPermissionsResult(
        requestCode: Int,
        permissions: Array<out String>,
        grantResults: IntArray
    ) {
        super.onRequestPermissionsResult(requestCode, permissions, grantResults)
        AzakawKyc.handlePermissionResult(requestCode, permissions, grantResults)
    }
}

Next Steps

After successful installation:

1. Review the Configuration guide for more details about AzakawKycConfig options
2. Check out the Usage Examples for more implementation scenarios
3. Explore our API Reference

Troubleshooting

If you encounter any issues during installation:

1. Build Errors

   • Ensure your project meets the minimum SDK requirements
   • Verify that the AAR file is correctly copied to the libs directory
   • Check that all required dependencies are properly declared
   • Confirm you're using the correct Gradle syntax for your build file type

2. Runtime Errors

   • Verify that the correct parameters are passed to AzakawKyc.start()
   • Check your application's permissions
   • Ensure you're handling permission results correctly

3. Common Issues

   • Missing dependencies: Add any missing required dependencies
   • Duplicate classes: Check for conflicts with other libraries
   • Proguard issues: Add proper Proguard rules if you're using code obfuscation

For additional support, contact our technical team at support@azakaw.com