Skip to content

Periculum-io/react-native-precision

Repository files navigation

react-native-precision

Precision library is a powerful & easy to use data enrichment tool for customer profiling.

Badges

License: MIT

Installation

Add react-native-precision to your project by running;

Yarn

yarn add react-native-precision

NPM

npm install react-native-precision

 

Info

You need to have a precision client account for this plugin to work. And also install the following packages for the plugin to work perfectly.

  • react-native-device-info
  • react-native-get-location
  • react-native-get-sms-android
  • react-native-permissions

 

Android Permissions

Please make sure you add the following android permissions in your AndroidManifest.xml file

<uses-permission android:name="android.permission.READ_SMS" />
<uses-permission android:name="android.permission.WRITE_SMS" />
<uses-permission android:name="android.permission.SEND_SMS" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>

 

Precision Analytics

How to use the Precision Analytics method. If you are using the V2 SDK methods then do the following:

Example:

import React from 'react';
import {analyticsRequestV2} from 'react-native-precision';

await analyticsRequestV2(publicKey, statementName, customerMobile, customerBvn)
  .then(result => {
    console.log({result});
  })
  .catch(error => {
    console.log({error});
  });

Precision Analytics V2 Parameters

Name Description Type Required
publickey Public Key attached to account String Yes
customerRef unique application refence String No
customerMobile customer phone number String Yes
customerBvn customer bvn String No

Response

Insights will return an overview key. You can send this overview key back to your backend server. Your backend server will use it's client credentials to make a to the insights mobile v2 endpoints for details related to the overview key.

   

Updating an existing mobile analytics

If you have a previously generated mobile overview key, you can update it with a new SDK data. to do this make the following call:

Example:

import React from 'react';
import {patchV2} from 'react-native-precision';

patchV2(
  publicKey,
  statementKey,
  identificationData,
)
  .then(result => {
    console.log(result);
  })
  .catch(error => {
    console.log(error);
  });

Updating an existing mobile V2 Analytics parameters

Name Description Type Required
publicKey Public Key attached to the client account String Yes
statementKey Unique statement reference int Yes
identificationData Array of object with keys of IdentifierName and Value array Yes

Response

Insights will update the previous overview key data with the latest data. You can use the overview key in your backend server with it's client credentials to make a call to the insights mobile v2 endpoints for details related to the overview key.

   

Setup

In order to utilize any of the SDK methods, you must have a public key. If you have not obtained your client public key, then you should contact Periculum standard support channel (email support@periculum.io).

 

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

About

Precision SDK is a powerful & easy to use customer analytics library for Android. No stress :)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published