Integrate with your app

This guide provides an overview of how to integrate our Android SDK into your app.

Prerequisites

  • Android Studio
  • A physical Android device (phone or tablet) with Android version 5.0+
  • Valid SDK credentials (SB Client ID, SB Secret, oAuth URL, API Base URL, and Callback URL)
  • Experience building Android Apps

Step 1: Add the Jitpack repository to your build file

  • Go to your Project > settings.gradle
  • Add the below code at the end of repositories:
maven { url "https://jitpack.io"}

Alt text

Step 2: Add the RMS SDK to your app

  • Go to your Project > app > build.gradle
  • Add the following dependency:
implementation('com.github.Retail-Merchant-Services:RMS-SB-ANDROID-SDK:1.0.8@aar'){
	transitive = true
}
  • Click Sync Now.

Alt text

Step 3: SDK Initialization

  • Inside the application global class, add the following code:
override fun onCreate() {
        super.onCreate()

        RmsClient.configure(
            this, RmsConfiguration(
                clientID = "3c65r36dinkd5n8fo4ud4829cn",
                clientSecret = "13dpgtvgfnqsn43drq20tdlvttps5m44luha7hauj6d6djua8j7f",
                callbackUrl = "rmssdk://www.rmssdk.com/callback",
                signOutUrl = "rmssdk://www.rmssdk.com/callback_signout",
                baseUrl = "https://api-terminal-sandbox.retailmerchantservices.net/",
                oAuthUrl = "api-auth-dev.retailmerchantservices.net"
            )
        )

        RmsClient.enableLogging()
    }

Alt text

💬 We're here to help!

If you're looking for help, shoot us an email. Please include a description of the issues that you are running into.