https://github.com/synerise/react-native-synerise-sdk
Synerise SDK wrapper for React Native
https://github.com/synerise/react-native-synerise-sdk
Last synced: 5 months ago
JSON representation
Synerise SDK wrapper for React Native
- Host: GitHub
- URL: https://github.com/synerise/react-native-synerise-sdk
- Owner: Synerise
- License: apache-2.0
- Created: 2019-11-05T10:00:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-12-15T12:28:49.000Z (7 months ago)
- Last Synced: 2025-12-18T14:14:58.028Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 6 MB
- Stars: 4
- Watchers: 15
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Synerise React Native SDK (react-native-synerise-sdk) (1.8.0)
[](https://github.com/synerise/ios-sdk)
[](https://github.com/synerise/android-sdk)
[](https://github.com/synerise/react-native-synerise-sdk)
[](https://www.npmjs.com/package/react-native-synerise-sdk)
[](https://synerise.com)
[](https://hub.synerise.com/developers/mobile-sdk/)
---
## About
[Synerise](https://www.synerise.com) SDK wrapper for React Native.
## Documentation
Most up-to-date documentation is available at [Developer Guide - Mobile SDK](https://hub.synerise.com/developers/mobile-sdk).
## Requirements
* Access to workspace
* A Profile API Key
* Development environment configured - [React Native - Setting up the development environment](https://reactnative.dev/docs/environment-setup)
### Android
* Minimum Android SDK version - 21
* Supported targetSDKVersion - 33
### iOS
* Xcode 15 and iOS SDK 17
* iOS 9.0+ minimum deployment target
* Valid architectures: arm64 devices and arm64, x86_64 simulators
## Installation
1. Install module by `npm`:
```bash
npm install react-native-synerise-sdk --save
```
2. If you are using React Native >= 0.60, install native dependencies via CocoaPods from your ios directory:
```bash
pod install
```
3. Or if you are using React Native < 0.60, link native dependency:
```bash
react-native link react-native-synerise-sdk
```
and then, install from your ios directory:
```bash
pod install --repo-update
```
4. Import Synerise SDK:
```javascript
import { Synerise } from 'react-native-synerise-sdk';
```
### iOS
**Important**:
Please note that starting from React Native 0.60, CocoaPods is now the default integration approach for React Native iOS projects.
1. Add `pod 'react-native-synerise-sdk', :path => '../node_modules/react-native-synerise-sdk'` as a dependency in your ios/Podfile.
2. Your Podfile should now look like this:
```ruby
target 'YourTarget' do
# Pods for your target
pod 'React', :path => '../node_modules/react-native/'
pod 'React-Core', :path => '../node_modules/react-native/React'
# ... other React dependencies
# Add react-native-synerise-sdk
pod 'react-native-synerise-sdk', :path => '../node_modules/react-native-synerise-sdk'
use_native_modules!
end
```
3. Run `pod install` from your ios directory.
If you prefer linking manually, check [React Native - Linking Libraries](http://facebook.github.io/react-native/docs/linking-libraries-ios.html#manual-linking) to link your libraries that contain native code.
### Android
1. Add `implementation 'com.synerise.sdk.react:react-native-synerise-sdk:0.15.0'` as a dependency in your app's build.gradle file.
2. Add `RNSyneriseSdkPackage` to your list your packages in application's main class as shown below:
```java
@Override
protected List getPackages() {
@SuppressWarnings("UnnecessaryLocalVariable")
List packages = new PackageList(this).getPackages();
packages.add(new RNSyneriseSdkPackage(getApplication()));
return packages;
}
```
## Initialization:
First of all, you need to initialize Synerise React Native SDK and provide `Profile API Key`.
To get `Profile API Key`, please sign in to your Synerise account and visit [https://app.synerise.com/settings/apikeys](https://app.synerise.com/settings/apikeys).
Then, generate new `API Key` for `Profile` audience.
```javascript
Synerise.Initializer()
.withClientApiKey('YOUR_PROFILE_API_KEY')
.init()
```
## Changelog
Changelog can be found [here](./CHANGELOG.md).
## Author
Synerise, developer@synerise.com. If you need support please feel free to contact us.