Kindred SDK with React Native

🚀 Kindred SDK integration into a React Native application

platform - android
platform - ios


This is a guide on how to integrate the Kindred SDK into your React Native application.

For any questions or support with your integration, or to receive your API details, please email [email protected]



⚠️ You must have Xcode installed (Tested on version 13.0)

  1. Download the Xcode Kindred Safari Template
  2. Navigate to your Xcode folder: Open new Finder window. Then go to Go -> Go to Folder and type ~/Library/Developer/Xcode

  1. Create a new folder called Templates, Copy across the Kindred Safari Extension.xctemplate to your newly created folder

  1. Open your Xcode iOS project, Select File -> New -> Target
    You should now see the Kindred Safari Extension under templates

  1. Create a new Kindred Safari Extension
  • Update the name and description of your extension

  • You can update the name and description from the file /Resources/_locales/en/messages

  • Update the required logos found in /Resources/icons

  1. Set your Kindred credentials
  • Open the info.plist of your extension, and set your Kindred credentials. Note, you need to set your CLIENT_ID, CLIENT_SECRET and SHARED_KEY.

⚠️ To get your Kindred credentials, please contact [email protected].

  1. You will now need to set up app groups within your Apple developer account.
    To create a new App Group, do the following:
  • Visit Apple's iOS Developer Centre, open your Account and log in.
  • Select Certificates, IDs & Profiles.
  • Under Identifiers select App Groups and click the + button to create a new group.
  • Enter a Name and an Identifier for the new group and click the Continue button:
  • Click the Register button to create the group and the Done to return to the list of registered App Groups.
  1. Now, back in Xcode, go to the Project Navigator -> Select your applications target -> Head to the Signing and Capabilities tab -> Click the + button and search for groups. Add an App Group.

  1. Under the App groups click the add button and will be prompted to select the development team

  1. Add the group Identifier that you created on step 7 and click OK

  1. Now head to your Kindred Extension target generated from the template and repeat step 8,9,10

  1. Head to your application info.plist and add a key for AppGroupName with a string value matching the group name you created in step 7.

  1. Now head to the Kindred extension info.plist generated from the template and add a key for AppGroupName with the same string value as step 7.

  1. Make sure on the template generated folder under your project, when you click the KindredSettings.swift the Target membership on the right has your project checked on Xcode:

  1. Right click your Project Name on Xcode and select new file

  1. Create a new Swift file named RNIKindredModule.swift and will be prompt to create a header bridge file click on Create Bridging Header

  1. Paste the following on the RNIKindredModule.swift file:

import Foundation

class RNIKindredModule: NSObject {
  func setUserId(_ userId: String){
    KindredSettings.shared.saveSetting(obj: userId, key: "KKUserId")
  func setUrlSchemeKey(_ urlScheme: String){
    KindredSettings.shared.saveSetting(obj: urlScheme, key: DataKey.KKAppSchemeKey)

  @objc func setUserCurrencyCode(_ currencyCode: String){
    KindredSettings.shared.saveSetting(obj: currencyCode, key: DataKey.KKUserCurrencyKey)
  @objc func setUserCountryCode(_ countryCode: String){
    KindredSettings.shared.saveSetting(obj: countryCode, key: DataKey.KKUserCountryKey)

  @objc func setShowEarningsConfirmationMessage(_ enabled: Bool) {
    KindredSettings.shared.saveSetting(obj: enabled, key: DataKey.KKShowEarningsConfirmationMessageKey)

  @objc func setShowCashbackLabel(_ enabled: Bool) {
      KindredSettings.shared.saveSetting(obj: enabled, key: DataKey.KKShowCashbackLabelKey)
  @objc func setShowEarthmark(_ enabled: Bool) {
      KindredSettings.shared.saveSetting(obj: enabled, key: DataKey.KKShowEarthmarkKey)
  @objc func setUseAnalytics(_ enabled: Bool) {
      KindredSettings.shared.saveSetting(obj: enabled, key: DataKey.KKUseAnalytics)

  @objc func isExtensionFirstTimeInstall(_ callback: RCTResponseSenderBlock){
    callback( [KindredSettings.shared.IsExtensionFirstTimeInstall() ] )

  1. Follow step 15 and create a new Objective C file named RNIKindredModule.m and paste the following:

#import <React/RCTBridgeModule.h>

@interface RCT_EXTERN_MODULE(RNIKindredModule, NSObject)
RCT_EXTERN_METHOD(setShowEarningsConfirmationMessage:(BOOL *)enabled)
RCT_EXTERN_METHOD(setShowCashbackLabel:(BOOL *)enabled)
RCT_EXTERN_METHOD(setShowEarthmark:(BOOL *)enabled)
RCT_EXTERN_METHOD(setUseAnalytics:(BOOL *)enabled)
RCT_EXTERN_METHOD(isExtensionFirstTimeInstall:(RCTResponseSenderBlock *)callback)

  1. On the Bridge file generated by Xcode namely <project-name>-Bridging-Header.h add the following on the file:

#import <React/RCTBridgeModule.h>

  1. On your project settings under Build Settings search for Defines Module set it to 'Yes'

⚠️ Make sure the All and Combined are selected as on the screenshot

Activation Call-To-Action


⚠️ AndroidX needs to be enabled for the SDK to work in your application

  1. edit your android/app/build.gradle file:
apply plugin: "kotlin-android"  // Add this at the top only if you don't have Kotlin setup

dependencies {
  // …

   implementation "io.github.kindred-app:browser-sdk:3.1.0" // Add this line
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" // Add this only if you don't have Kotlin setup

  // …
  1. Edit your android/app/src/main/res/values/strings.xml file:

  <!-- Add the following (Note, you can change these values as applicable)   -->

    <string name="accessibility_service_description">By allowing the Accessibility Permission, you permit “App Name” to access data about your URLs. We do this to enable you to save money when you are shoppingon your favourite brands, coupon codes will pop up at checkout, helping you to save!</string>
    <string name="accessibility_service_label">Kindred</string>


  1. Create file accessibilityservice.xml on android/app/src/main/res/xml path and add the following:
  <!--Note if the /xml path does not exist on your project you can add it in -->

  <!-- Copy and paste the following  -->

<accessibility-service xmlns:android=""
  1. Add permissions to the android/app/src/main/AndroidManifest.xml file:
    <!-- Copy and paste the following  -->

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />

  1. Create file DealsAccessibilityService.kt on android/app/src/main/java/com path and add the following:

//  Note: if you are not using the "show earnings" feature, set the feature flag to false. See What is "Show Earnings" feature flag? below.

// paste the following 

package // make sure this matches your package path on your

import com.kindred.browser_sdk.KindredAbstractAccessibilityService
import com.kindred.browser_sdk.configuration.*

class DealsAccessibilityService : KindredAbstractAccessibilityService() {

    companion object {
        val kindredApiConfiguration = KindredApiConfiguration(
            urlBase = "",
            clientID = "[YOUR_AUTH_CLIENT_ID]",
            clientSecret ="[YOUR_AUTH_CLIENT_SECRET]",
            sharedKey = "[YOUR_AUTH_SHARED_KEY]",
            cdnUrl = ""

    override fun configureService() = KindredAccessibilityServiceConfiguration(
        api = kindredApiConfiguration,
        user = KindredUserConfiguration(
            userCurrency = "CURRENCY_CODE",
            userCountry = "COUNTRY_CODE"
        features = KindredFeaturesConfiguration(
          showEarningsConfirmationMessage = true,
        	earthMarkScoring = true,
          showCashbackLabel = true
        charity = KindredCharityConfiguration(
            charityId = "CHARITY_ID",
            charityShare = CHARITY_SHARE

    override fun onCreate() {
      	// The default configuration gives each user a unique user ID unless you wish to specify one here
        // Note the "[logo]" needs to be changed to your logo see below how to change it


 Find out more about EarthMark and Show Earnings feature flags?

⚠️ Note to change the logo of the accessibility service (defaulted to Kindred logo), add a image to the android/app/src/main/res/drawable folder and change the "[logo]" with the name of the image stored

  1. Edit your android/app/src/main/AndroidManifest.xml file:
<manifest xmlns:android=""

  <!-- … -->

    <!-- Note Make sure that `` matches your main application Path -->
    <!-- Copy the following and paste inside your application tag -->
                <action android:name="android.accessibilityservice.AccessibilityService" />
                android:resource="@xml/accessibilityservice" />
    <!-- … -->

  1. Create file on android/app/src/main/java/com path and add the following:

  // paste the following 

package; // make sure this matches your package path on your

import android.accessibilityservice.AccessibilityServiceInfo;
import android.content.Context;
import android.content.Intent;
import android.os.Build;
import android.provider.Settings;
import android.view.accessibility.AccessibilityManager;
import android.view.inputmethod.InputMethodInfo;
import android.view.inputmethod.InputMethodManager;
import android.content.SharedPreferences;

import androidx.annotation.NonNull;
import androidx.annotation.RequiresApi;

import com.facebook.react.bridge.Callback;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.bridge.ReactContextBaseJavaModule;
import com.facebook.react.bridge.ReactMethod;

import java.util.List;

public class RNReactNativePluginSettings extends ReactContextBaseJavaModule {
    SharedPreferences sharedPreferences;

    RNReactNativePluginSettings(ReactApplicationContext context) {
        sharedPreferences = context.getSharedPreferences("kindred", context.MODE_PRIVATE);
    public void openAccessibilitySettings() {
        Activity currentActivity = getCurrentActivity();
        currentActivity.startActivity(new Intent(Settings.ACTION_ACCESSIBILITY_SETTINGS));

    public void isEnabled(Callback callback) {
        Activity currentActivity = getCurrentActivity();

        Boolean isEnabled = false;

        AccessibilityManager am = (AccessibilityManager) currentActivity.getSystemService(Context.ACCESSIBILITY_SERVICE);
        List<AccessibilityServiceInfo> enabledServices = am.getEnabledAccessibilityServiceList(AccessibilityServiceInfo.FEEDBACK_ALL_MASK);

        for (AccessibilityServiceInfo enabledService : enabledServices) {
            ServiceInfo enabledServiceInfo = enabledService.getResolveInfo().serviceInfo;
            if (enabledServiceInfo.packageName.equals(currentActivity.getPackageName()))
                isEnabled = true;

        callback.invoke(null, isEnabled);

    public void setUserId(String userId) {
        sharedPreferences.edit().putString("KKUserId", userId).apply();

    public String getName() {
        return "RNReactNativePluginSettings";

  1. Create file on android/app/src/main/java/com path and add the following:

  // paste the following 

package; // make sure this matches your package path on your

import androidx.annotation.NonNull;

import com.facebook.react.ReactPackage;
import com.facebook.react.bridge.NativeModule;
import com.facebook.react.bridge.ReactApplicationContext;
import com.facebook.react.uimanager.ViewManager;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class KindredPackage implements ReactPackage {
    public List<NativeModule> createNativeModules(@NonNull ReactApplicationContext reactContext) {
        List<NativeModule> modules = new ArrayList<>();
        modules.add(new RNReactNativePluginSettings(reactContext));

        return modules;

    public List<ViewManager> createViewManagers(@NonNull ReactApplicationContext reactContext) {
        return Collections.emptyList();

  1. Update the on android/app/src/main/java/com path and add the following:
// update the following 

    protected List<ReactPackage> getPackages() {
      List<ReactPackage> packages = new PackageList(this).getPackages();

      packages.add(new KindredPackage()); // Add this line

      List<ReactPackage> unimodules = Arrays.<ReactPackage>asList(new ModuleRegistryAdapter(mModuleRegistryProvider));

      return packages;

React Native

Add a File KindredPluginSettings.ts to your project src

// Paste the following

import { NativeModules, Platform } from 'react-native';
const { RNReactNativePluginSettings } = NativeModules;

export default class KindredPluginSettings {

//Note(Android): Used to  open the settings on the android devices to allow users to be able to enable the Kindred SDK by enabling it on the accessibility service
  static async openPlugin() {
    if (Platform.OS === 'android') {
//Note(Android): Used to checks if the Kindred service has been enabled on a android device

  static async isEnabled() {
    return new Promise((resolve, reject) => {
      if (Platform.OS === 'android') {
        RNReactNativePluginSettings.isEnabled((errorCode: any, isEnabled: boolean) => {
          if (errorCode) {
          } else {
      } else {
// Note(Required Android/iOS): Provide your own user ID or a unique identifier for the user for analytic purposes, you can provide the SDK with you own unique ID :

  static async setUserId(userID: string) {
    if (Platform.OS === 'android') {
    } else {

  //Note(optional iOS only): Once we track successful transactions for the user and they have earned some cashback, we present them with a popup that has a call to action back to the app. In order for this to function, you must provide us with the url scheme you have set for your app.

  static async setAppUrlScheme(urlScheme: string) {
       if (Platform.OS === 'ios') {
 //Note(optional iOS only): used to set the currency code for user, default value is 'USD'
 static async setUserCurrencyCode(currencyCode: string) {
    if (Platform.OS === 'ios') {

 //Note(optional iOS only): used to set the country code for user, default value is 'US'
 static async setUserCountryCode(countryCode: string) {
    if (Platform.OS === 'ios') {

   // Note(optional iOS only):Show Earnings feature flag. You can turn the feature flag on/off . learn more about this feature flag on below

  static async setShowEarningsConfirmationMessage(enabled: boolean) {
    if (Platform.OS === 'ios') {
  // Note(optional iOS only): Show cashback label feature flag. You can turn on/off the cashback label feature flag. learn more about this feature flag on below

  static async setShowCashbackLabel(enabled: boolean) {
    if (Platform.OS === 'ios') {

  // Note(optional iOS only): Show Earthmark feature flag. You can turn on/off the show Earthmark  feature flag. learn more about this feature flag on below

  static async setShowEarthmark(enabled: boolean) {
    if (Platform.OS === 'ios') {

  // Note(optional iOS only): Use Analytics feature flag.Use this if you would like to have analytics tracking turned on
  // NOTE: If you would like to opt in to analytics, you will also need to contact Kindred to ensure that your account is configured for analytics. Contact [email protected]
  // This allows Kindred to track analytics on the following:
  // 1. Extension installation and enabling
  // 2. Latest activity
  // 3. Deal activations
  // 4. Conversions

  static async setUseAnalytics(enabled: boolean) {
    if (Platform.OS === 'ios') {

  // Note(optional iOS only): Detecting if the extension was installed. This will return either a true or false value.
  // NOTE: You will need to follow the steps for enabling the App Groups in order to use this functionality.
  // One thing you may need to know is if your users have activated the extension. This is possible by using the following method for IOS and isEnabled for Android users:

  static async isExtensionFirstTimeInstall() {
    return new Promise((resolve, reject) => {
      if (Platform.OS === 'ios') {
          (isFirstTimeInstall: boolean) => {
      } else {


  To learn more about URL scheme, please visit:

⚠️ Note Make sure you set a unique userId for your users using setUserId(userID: string) method

Usage Example

import React, {useCallback, useEffect, useState} from 'react';
import {
} from 'react-native';
import KindredPluginSettings from './KindredPluginSettings';

const App = () => {
  const [uniqueID, setUniqueID] = useState('');
  const urlScheme = 'test2project';
  const [inactive, setInactive] = useState(false);
  const handleOnPress = async () => {
    if (Platform.OS === 'android') {
      await KindredPluginSettings.openPlugin();
    } else {
      const instructionsLink =
        '' + urlScheme;
      Linking.canOpenURL(instructionsLink).then(supported => {
        if (supported) {

  useEffect(() => {
    AppState.addEventListener('change', handleAppStateChange);
  }, []);

  const handleAppStateChange = useCallback(
    (change: string) => {
      if (change === 'inactive' || change === 'background') {
      if (change === 'active' && inactive) {
        if (Platform.OS === 'android') {
          KindredPluginSettings.isEnabled().then(isEnabled => {
            if (isEnabled) {
        } else {

    [inactive, uniqueID],

  return (
        <Text>Welcome to plugin test interface</Text>
        <TouchableOpacity style={styles.button} onPress={() => handleOnPress()}>
          <Text style={styles.text}>Activate Plugin</Text>

const styles = StyleSheet.create({
  highlight: {
    fontWeight: '700',
  text: {
    color: 'white',
    textAlign: 'center',
    fontSize: 30,
  button: {
    backgroundColor: 'blue',
    width: '70%',
    height: 50,
    borderRadius: 20,

export default App;

Verify the solution

  1. Open Browser/Safari for iOS
  2. Visit your favourite brands

Try visiting Nike, Adidas or John Lewis

What is "Show Earnings" feature flag?

If you would like us to popup to the user whenever they've made any cash back or donated to a cause, you can set this feature flag on when setting up the configuration on the DealsAccessibilityService for Android and using KindredPluginSettings.setShowEarningsConfirmationMessage(true) for IOS.

What is "EarthMark" feature flag?

Earthmark have developed a rating system to show how "green" retailers really are. Earthmark's rating system will now be highlighted within the Kindred technology so partners can help their users make more informed choices to shop sustainably.

What is "Show Cashback label" feature flag?

You can turn on/off the cashback label feature flag. Having it on means that when we detect a cashback deal, the user will be notified through the popups with text indicating how much cashback they would be earning. Having the feature off means that there will not be any reference to cashback or cashback amount instead, will reference a deal.

Feature flag off

Feature flag on

License Agreement: