Android SDK for ARCaptcha

Installation | Example

This SDK provides a native sdk for ARCaptcha. You will need to configure a site key and a secret key from your arcaptcha account in order to use it.

Installation

Gradle

// Step 1. Add it in your root settings.gradle at the end of repositories:
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}
// Step 2. Add the dependency
dependencies {
    implementation 'com.github.arcaptcha:arcaptcha-native-android-sdk:v1.0.3'
}

Maven

//Step 1. Add to pom.xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

//Step 2. Add the dependency
<dependency>
    <groupId>com.github.arcaptcha</groupId>
    <artifactId>arcaptcha-native-android-sdk</artifactId>
    <version>v1.0.3</version>
</dependency>

Display a Question challenge

The following snippet code will ask the user to complete a Question challenge.

XML

<co.arcaptcha.arcaptcha_native_sdk.containers.QuestionContainerView
    android:id="@+id/mainQuestionContainer"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

Kotlin

val questArcApi = ArcaptchaAPI("<YOUR_SITE_KEY>", "<YOUR_DOMAIN>")

mainQuestContainer.initCaptcha(questArcApi, object : CaptchaCallback {
    override fun onCorrectAnswer(token: String) {
        Log.d("Puzzle Token", token)
    }

    override fun onError(message: String) {
        Log.d("Puzzle Error", message)
    }

    override fun onWrongAnswer() {
        mainQuestContainer.loadCaptcha()
    }

    override fun onStateChanged(state: CaptchaState) {
        if(state == CaptchaState.LoadingCaptcha) {
        }
    }
})

mainQuestContainer.loadImageCaptcha()
// OR: mainQuestContainer.loadVoiceCaptcha()

Display a Puzzle challenge

The following snippet code will ask the user to complete a Puzzle challenge.

XML

<co.arcaptcha.arcaptcha_native_sdk.containers.PuzzleContainerView
    android:id="@+id/puzzleContainer"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

Kotlin

val puzzleArcApi = ArcaptchaAPI("<YOUR_SITE_KEY>", "<YOUR_DOMAIN>")

puzzleContainer.initCaptcha(puzzleArcApi, object : CaptchaCallback {
    override fun onCorrectAnswer(token: String) {
        Log.d("Puzzle Token", token)
    }

    override fun onError(message: String) {
        Log.d("Puzzle Error", message)
    }

    override fun onWrongAnswer() {
        puzzleContainer.loadCaptcha()
    }

    override fun onStateChanged(state: CaptchaState) {
        if(state == CaptchaState.LoadingCaptcha) {
        }
    }
})

puzzleContainer.loadCaptcha()

Display a Question challenge in Jetpack Compose

Add this theme to themes.xml

XML

<style name="AppTheme" parent="Theme.MaterialComponents.DayNight.NoActionBar">
    <item name="materialButtonStyle">@style/Widget.MaterialComponents.Button</item>
</style>

Kotlin

@Composable
fun ArcaptchaQuestion(
    siteKey: String,
    domain: String,
    modifier: Modifier = Modifier,
    onCorrect: (token: String) -> Unit,
    onError: (message: String) -> Unit
) {
    AndroidView(
        modifier = modifier,
        factory = { ctx ->
            val themedContext = ContextThemeWrapper(ctx, R.style.AppTheme)

            val container = QuestionContainerView(themedContext).apply {
                val api = ArcaptchaAPI(siteKey, domain)
                initCaptcha(api, object : CaptchaCallback {
                    override fun onCorrectAnswer(token: String) {
                        onCorrect(token)
                    }

                    override fun onWrongAnswer() {
                        loadCaptcha()
                    }

                    override fun onError(message: String) {
                        onError(message)
                    }

                    override fun onStateChanged(state: CaptchaState) {}
                })

                loadImageCaptcha()
            }

            container
        },
        update = { view -> }
    )
}

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()
        setContent {
            MyApplicationTheme {
                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                    ArcaptchaQuestion(
                        siteKey = "<YOUR_SITE_KEY>",
                        domain = "<YOUR_DOMAIN>",
                        onCorrect = { token -> },
                        onError = { message -> }
                    )
                }
            }
        }
    }
}