Requestly Android SDK

Requestly Android SDK lets you debug your android apps without needing you to setup any proxies or install any certificates everytime. It makes easy to identify & debug your Android Apps faster and save your time.

• Installation
• SDK Initialization
• API Debugger Initialization
  • okHttp
  • Retrofit
• Features
  • API Debugger
  • Analytics Event Debugger
• Acknowledgments

Installation

The best way to install the Requestly Android SDK is with a build system like Gradle. This ensures you can easily upgrade to the latest versions.

RQInterceptor is distributed through Maven Central. To use it you need to add the following Gradle dependency to your build.gradle file of you android app module (NOT the root file)

dependencies {
    debugImplementation "io.requestly:requestly-android:2.1.0"
    releaseImplementation "io.requestly:requestly-android-noop:2.1.0"
    debugImplementation "io.requestly:requestly-android-okhttp:2.1.0"
    releaseImplementation "io.requestly:requestly-android-okhttp-noop:2.1.0"
}

SDK Initialization

Initialize the Requestly SDK in your Application class onCreate method.

class App : Application(){
    override fun onCreate() {
        super.onCreate()
        
        // Initialize Requestly SDK like this
        Requestly.Builder(this, "<your-sdk-key>")
            .build()
    }
}

To get the sdk key, you need to create an app. Follow the steps here to create an app.

API Debugger Initialization

To configure the Interceptor, you need to initialize the RQCollector and then add rqInterceptor as the last interceptor to your okHttpClient

okHttp

val collector = RQCollector(context=appContext)

val rqInterceptor = RQInterceptor.Builder(appContext)
    .collector(collector)
    .build()
    
val client = OkHttpClient.Builder()
    .addInterceptor(rqInterceptor)
    .build()

Retrofit

Retrofit.Builder()
    .baseUrl(APIUtils.API_BASE_URI)
    .client(okHttpClient) // okHttpClient with RQInterceptor
    .build();

Features

API Debugger

Lets you view and modify HTTP traffic. It comes with these capabilities to:

• InApp Inspector : Directly view your HTTP request from your phone.
• Modify API: Modify Response, Redirect Request, Delay Request and many more.

Analytics Event Debugger

Debug & Validate your Analytics Events directly from your App. The SDK provides a simple API to send your events.

RequestlyEvent.send(<eventName: String>, <eventData:Map<String, Any>>)

Acknowledgments

Special Thanks to chuckerteam for maintaining such an awesome project because of which rq-interceptor was possible https://github.com/chuckerteam/chucker