@seontechnologies/seon-react-native-mobile-wrapper
v3.1.0
Published
SEON Mobile SDK React Native Wrapper
Downloads
2,048
Readme
SEON Mobile SDK React Native Wrapper
This package provides a React Native wrapper for the SEON Mobile SDK, allowing you to integrate SEON's Device Intelligence module into your React Native projects. It supports both Android and iOS platforms.
Installation
Install the package in your existing React Native project:
npm install @seontechnologies/seon-react-native-mobile-wrapper
Usage
Import the SEON wrapper in your JavaScript files:
import { SeonReactNativeMobileWrapper as Seon } from '@seontechnologies/seon-react-native-mobile-wrapper';
Basic Usage
Here's a basic example of how to use the SEON wrapper:
// Replace 'YOUR_UNIQUE_SESSION_ID' with your actual session identifier.
await Seon.setSessionId('YOUR_UNIQUE_SESSION_ID');
// Enable logging (optional)
await Seon.setLoggingEnabled(true);
// Generate fingerprint
try {
const fingerprint = await Seon.getFingerprintBase64();
// Send 'fingeprint' to your backend and use it as the session property
// for your Fraud API request.
} catch (error) {
// Handle errors
}
Behaviour Monitoring
The SEON SDK can monitor user behaviour to collect behaviour-based signals. It's recommended to run the monitoring for at least a few seconds to gather sufficient data.
Starting Behaviour Monitoring
await Seon.startBehaviourMonitoring();
// Stopping Behaviour Monitoring
try {
const behaviourData = await Seon.stopBehaviourMonitoring();
// Send 'behaviourData' to your backend and use it as the session property
// for your Fraud API request.
} catch (error) {
// Handle errors
}
Geolocation Configuration
The SEON SDK supports geolocation services. You can configure these services using the SeonGeolocationConfig
interface:
Permissions
Ensure that your application has the necessary permissions to access location services. Update your app's configuration files and request permissions at runtime.
iOS
Add the following keys to your Info.plist file with appropriate usage descriptions:
- NSLocationWhenInUseUsageDescription
- NSLocationAlwaysAndWhenInUseUsageDescription (if needed)
Android
Add the following permissions to your AndroidManifest.xml:
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
Note: Remember to request location permissions at runtime.
Enabling Geolocation Services
await Seon.setGeolocationEnabled(true);
OR
const geolocationConfig = {
prefetchEnabled: true,
geolocationServiceTimeoutMs: 5000, // in milliseconds
maxGeoLocationCacheAgeSec: 300, // in seconds
geolocationEnabled: true,
};
await Seon.setGeoLocationConfig(geolocationConfig);
prefetchEnabled
: When enabled, SEON pre-fetches location on creation of a SeonReactNativeMobileWrapper object for better performance.geolocationServiceTimeoutMs
: Network timeout for SEON's geolocation services in milliseconds. Default is 3000.maxGeoLocationCacheAgeSec
: Maximum location data age permitted in seconds. Default is 600.geolocationEnabled
: Enables or disables SEON's geolocation services.
Platform Specific Notes
- Make sure you have the necessary permissions set up in your Android and iOS projects for geolocation services if you plan to use them.
Error Handling
All methods return promises, so you can use try-catch blocks or .catch() to handle any errors that might occur during the SDK operations. For the possible errors and statuses please visit the SDK repositories.
Please note that if a Geolocation error occur, the SDK should still return a valid fingerprint object which can be used as the session property for the regular Fraud API requests if needed.
Additional Information
For more detailed information about the iOS and Android SDKs, please refer to their respective GitHub repositories:
Support
If you encounter any issues or have questions about the SEON Mobile SDK React Native Wrapper, please contact SEON support or refer to the official SDK documentations.
Release Notes
3.1.0
IMPORTANT: This version is going to introduce a new Fraud API response field named true_device_id.
- Upgraded to Android SDK v6.6.0. For more detailed change logs please visit the SDK repository.
- Upgraded to iOS SDK v5.5.1. For more detailed change logs please visit the SDK repository.
- Unified GeolocationConfig object, it now has full availability on iOS as well.
- Added geolocationEnabled chain to the configuration builder on Android.
- Unified error messages.
- Added status codes to error messages.
- Added support to SEON's Geofence API.