Install the Monetate SDKs

This documentation guides you through setting up and implementing the React Web, React Native, iOS, and Android versions of the Monetate SDK.
React Web
Prerequisites
You must have Node and Yarn installed to set up this SDK. Refer to the installation instructions for Node and Yarn for more information.
Installing and Importing Packages
The React Web version of the Monetate SDK consists of these packages:
Web: For applications written in React JavaScript
Common: Methods and constants shared between the React Native and Web packages
To install the SDK packages, first set the default Artifactory npm registry using the following command:
Command to Set the Default Artifactory npm Registry
npm config set registry https://monetate.jfrog.io/artifactory/api/npm/monetate-npm-local
npm config set registry https://monetate.jfrog.io/artifactory/api/npm/monetate-npm-local
﻿
Next, install the desired SDK packages with each of the following codes:
Command to Install the Web SDK Package
npm install @personalization-js-sdk/web
npm install @personalization-js-sdk/web
﻿
Command to Install the Common SDK Package
npm install @personalization-js-sdk/common
npm install @personalization-js-sdk/common
﻿
If you encounter a peer dependencies error during installation, add the line --legacy-peer-deps to the installation command.
Getting Started
Use the following code to initialize an object to communicate with the Engine API:
Code to Initialize an Object to Communicate with Engine API
const sdkInstace = new Personalization(account, user);
const sdkInstace = new Personalization(account, user);
﻿
React Native
Prerequisites
You must have Node and Yarn installed to set up this SDK. Refer to the installation instructions for Node and Yarn for more information.
Installing and Importing Packages
The React Native version of the Monetate SDK consists of these packages:
React Native: For applications written using the React Native framework
Common: Methods and constants shared between the React Native and Web packages
To install the SDK packages, first set the default Artifactory npm registry using the following command:
Command to Set the Default Artifactory npm Registry
npm config set registry https://monetate.jfrog.io/artifactory/api/npm/monetate-npm-local
npm config set registry https://monetate.jfrog.io/artifactory/api/npm/monetate-npm-local
﻿
Next, install the desired SDK packages with each of the following codes:
Command to Install the React Native SDK Package
npm install @personalization-js-sdk/react-native
npm install @personalization-js-sdk/react-native
﻿
Command to Install the Common SDK Package
npm install @personalization-js-sdk/common
npm install @personalization-js-sdk/common
﻿
If you encounter a peer dependencies error during installation, add the line --legacy-peer-deps to the installation command.
Getting Started
Use the following code to initialize an object to communicate with the Engine API:
Code to Initialize an Object to Communicate with Engine API
const sdkInstace = new Personalization(account, user);
const sdkInstace = new Personalization(account, user);
﻿
iOS
Prerequisites
You must have CocoaPods installed to set up this SDK. Refer to Getting Started in the CocoaPods Guides for more information.
Installing the SDK
Complete the following steps to integrate the SDK within your app.
First, open the PodFile and add the following code:
Code to Begin Installing Monetate SDK
target 'monetate' do
  # Comment the next line if you do not want to use dynamic frameworks
  use_frameworks!
  pod 'monetate-ios-sdk'
  # Pods for monetate
  post_install do |installer|
    installer.generated_projects.each do |project|
	  project.targets.each do |target|
	    target.build_configurations.each do |config|
		  config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.0'
		end
	  end
	end
  end
end
target 'monetate' do
  # Comment the next line if you do not want to use dynamic frameworks
  use_frameworks!
  pod 'monetate-ios-sdk'
  # Pods for monetate
  post_install do |installer|
    installer.generated_projects.each do |project|
	  project.targets.each do |target|
	    target.build_configurations.each do |config|
		  config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = '13.0'
		end
	  end
	end
  end
end
﻿
Next, go to the root path of your project in the terminal and run pod install.
After installation, the SDK appears in the Pods directory in your project sidebar.
﻿
Getting Started
Use the following code to initialize an object to communicate with the Engine API:
Code to Initialize an Object to Communicate with Engine API
final var objPersonalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(monetateId: "2.1454546575.1711006580023", deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345"))
final var objPersonalization = Personalization(account: Account(instance: "p", domain: "localhost.org", name: "a-701b337c", shortname: "localhost"), user: User(monetateId: "2.1454546575.1711006580023", deviceId: "62bd2e2d-213d-463f-83bb-12c0b2530a14", customerId: "12345"))
﻿
Android
Prerequisites
You must have Android Studio installed to set up this SDK. Refer to the Android Studio site for more information.
Integrating the SDK into a Project
Complete the following steps to integrate the SDK within your app.
First, download the SDK source, and then open your app project and switch to Project View.
﻿
Next, copy and paste the SDK into the app > libs directory.
﻿
Open the build.gradle(:app) file and include the following code under the dependencies section:
Dependencies Code
implementation fileTree(include: ['*.jar'], dir: 'libs')
implementation fileTree(include: ['*.jar'], dir: 'libs')
﻿
﻿
Finally, click Sync Now in the notification that appears prompting you to perform a project sync.
Getting Started
Use the following code to initialize an object to communicate with the Engine API:
Code to Initialize an Object to Communicate with Engine API
sdkInstace = new Personalization(account, user);
sdkInstace = new Personalization(account, user);
﻿
﻿
Updated 26 Sep 2024
Getting Started with Monetate SDKs
SDK Objects