socure-inc / socure-sigmadevice-wrapper-react-native

This wrapper library provides a framework to integrate Sigma Device data collection into your React Native application.
MIT License
5 stars 4 forks source link

Socure Device Risk SDK React Native Bridge

The Socure Device Risk SDK React Native bridge provides Reach developers with the ability to call the Socure Device Risk SDK, either the Android or iOS native library variants, through React.

This guide covers the integration within React, as well as React Native implementation on iOS and Android.

Minimum Requirements iOS 13 and above Android SDK version 34 and above

Introduction

Please read the documentation on either the Android or iOS native library variants to understand how the Device Risk SDK works.

Installation

Please follow the instructions below to add this wrapper library to your project. Alternatively, you can use this sample app as a starting point.

Add the following dependency to package.json:

npm install --save @socure-inc/react-native-device-risk

Android

Step 1: Open the module level build.gradle for the main project module and inside of the defaultConfig section, set the minSdkVersion to 34

Step 2: Synchronize your gradle projects
The Android side of the Bridge should be ready to run.

Note: If pulling from Maven, implement the below)

buildscript {
    …………..
    dependencies {
        ……………………
        classpath ‘com.github.dcendents:android-maven-gradle-plugin:1.5’
    }
}

(NOT IN THE buildscript code block above. allprojects is a sibling to build script)

You will receive a username and token from Socure
Place these variables in you gradle.properties file inside your Android project

allprojects {
    repositories {
        …….

        maven {url "https://sdk.socure.com/"}
    }
}

Step 3:

In the main module (<root project dir>/android/app/build.gradle) add the below dependency in dependencies {} section:

dependencies {
   .....
   implementation "org.jetbrains.kotlin:kotlin-stdlib:x.x.x"
   .....
}

Note: Socure has tested the build with plugin version 1.8.10.

Build and run:

iOS

Step 1: Install Socure SDK React Native Bridge using CocoaPods (recommended)

Inside your target, add the corresponding pod lines

use_frameworks!

  pod 'SocureDeviceRisk'

Update your pods from the terminal

pod install

You can also copy the folder react-native-device-risk and add it along with your other React Native pods.

Step 2: Add appropriate permissions for the services you want DeviceRisk SDK to use

This is explained in more detail in the native iOS library’s documentation

Step 3:

Configuration and usage

For instructions on how to configure the SDK, see the React Native documentation on DevHub.

Example

You can checkout the example app from here. The file App.js shows the JS function calls used and how to ultimately retrieve the Device Risk Session ID.