Requirements
Min SDKAPI 21 (Android 5.0)
Target SDKAPI 34+
Kotlin Version1.8.0+
Binary Size< 250 KB
Step 1: Add JitPack Repository
In your project-level settings.gradle or build.gradle:
settings.gradlegroovy
dependencyResolutionManagement {
repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
repositories {
google()
mavenCentral()
maven { url 'https://jitpack.io' }
}
}Step 2: Add Dependency
In your app-level app/build.gradle:
app/build.gradlegroovy
dependencies {
implementation 'com.github.perkoxofficial:perkox-android-sdk:v2.41'
}Step 3: AndroidManifest.xml Permissions
AndroidManifest.xmlxml
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
<!-- Required permissions -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- Optional: For advertising ID attribution -->
<uses-permission android:name="com.google.android.gms.permission.AD_ID" />
</manifest>Step 4: Initialize & Launch Offerwall
import com.perkox.sdk.PerkoxOfferwall
class MainActivity : AppCompatActivity() {
private lateinit var offerwall: PerkoxOfferwall
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
// 1. Initialize Perkox Offerwall
offerwall = PerkoxOfferwall(
appId = "YOUR_APP_ID",
playerId = "USER_12345",
context = this
)
// 2. Optional: Set event callbacks
offerwall.setOnReward { reward ->
val amount = reward["amount"] as? Double
val status = reward["status"] as? String
val txid = reward["txid"] as? String
Log.d("Perkox", "Reward received: $amount $status ($txid)")
}
offerwall.setOnClose {
Log.d("Perkox", "Offerwall was closed by user")
}
// 3. Launch Offerwall on button click
findViewById<Button>(R.id.btnOfferwall).setOnClickListener {
offerwall.launch(this)
}
}
}Reward Callback Object
| Field | Type | Description |
|---|---|---|
| amount | Double | Virtual currency reward amount based on your exchange rate. |
| status | String | "approved" or "rejected" or "chargeback". |
| txid | String | Unique conversion transaction ID for idempotency. |
| player_id | String | Your app user identifier. |
S2S Postback Recommended for Real Rewards
While the client-side
setOnReward callback is useful for showing instant toast celebrations or in-app animations, always rely on Server-to-Server Postbacks to safely persist currency in your backend database.
