Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 1.81 KB

README.md

File metadata and controls

71 lines (50 loc) · 1.81 KB
Raw

kotlin-recaptcha-client

kotlin-recaptcha-client is an kotlin library for server side reCAPTCHA verification, supports both recaptcha v2 and recaptcha v3

This client aims to be as simple as possible

"reCAPTCHA is a free CAPTCHA service that protects websites from spam and abuse."

Installation

Via package manager:

Still in the phase of uploading to the maven central, not ready yet

Usage

For v2 client:

import com.wusatosi.recaptcha.v2.RecaptchaV2Client

val v2Client = RecaptchaV2Client("your secret key...")

runBlocking {
  // RecaptchaV2Client.verify is an suspend function
  val result: Boolean = v2Client.verify(token)
  
  // ...
}

For v3 client

import com.wusatosi.recaptcha.v3.RecaptchaV3Client

val v3Client = RecaptchaV3Client("your secret key...")
runBlocking {

  // RecaptchaV3Client.getVerifyScore is an suspend function
  val result: Double = v3Client.getVerifyScore(token)
  
  // ...
}

Supports using "www.recaptcha.net" instead of "www.google.com" as the API endpoint, for google side more documentation, this can be enable via:

// V2
RecaptchaV2Client("your secret key...", true)
// RecaptchaV2Client("your secret key...", useRecaptchaDotNetEndPoint = true)

// V3
RecaptchaV3Client("your secret key...", true)
// RecaptchaV3Client("your secret key...", useRecaptchaDotNetEndPoint = true)

Contributing

Issues, pull requests, all always welcome

Uses:

  • Kotlin-coroutines, version 1.1.0
  • Fuel (http client), version 1.16.0
  • Gson, version 2.8.5

License

MIT