Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fingerprintjs/fingerprintjs-pro-react-native
Official React Native client for Fingerprint PRO. 100% accurate device identification for fraud detection.
https://github.com/fingerprintjs/fingerprintjs-pro-react-native
fingerprint fingerprintjs fingerprintjs-pro fraud-detection integration react react-native
Last synced: 6 days ago
JSON representation
Official React Native client for Fingerprint PRO. 100% accurate device identification for fraud detection.
- Host: GitHub
- URL: https://github.com/fingerprintjs/fingerprintjs-pro-react-native
- Owner: fingerprintjs
- License: mit
- Created: 2022-01-20T14:11:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-10T17:30:10.000Z (2 months ago)
- Last Synced: 2024-09-10T19:41:40.132Z (2 months ago)
- Topics: fingerprint, fingerprintjs, fingerprintjs-pro, fraud-detection, integration, react, react-native
- Language: TypeScript
- Homepage: https://fingerprint.com
- Size: 3.05 MB
- Stars: 56
- Watchers: 10
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: contributing.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Fingerprint Pro React Native
[Fingerprint](https://fingerprint.com/) is a device intelligence platform offering 99.5% accurate visitor
identification. Fingerprint Pro React Native SDK is an easy way to integrate Fingerprint Pro into your React Native
application to call the native Fingerprint Pro libraries (Android and iOS) and identify devices.
## Table of contents
* [Requirements and limitations](#requirements-and-limitations)
* [Dependencies](#dependencies)
* [How to install](#how-to-install)
* [Usage](#usage)
* [Hooks approach](#hooks-approach)
* [API Client approach](#api-client-approach)
* [`extendedResponseFormat`](#extendedresponseformat)
* [Linking and tagging information](#linking-and-tagging-information)
* [API Reference](#api-reference)
* [Additional Resources](#additional-resources)
* [Support and feedback](#support-and-feedback)
* [License](#license)
## Requirements and limitations
- React Native 0.73 or higher
- Android 5.0 (API level 21+) or higher
- iOS 13+/tvOS 15+, Swift 5.7 or higher (stable releases)
- Fingerprint Pro [request filtering](https://dev.fingerprint.com/docs/request-filtering) is not supported right now. Allowed and forbidden origins cannot be used.
- Usage inside the [Expo environment](https://docs.expo.dev) is not supported right now.
## Dependencies
- [Fingerprint Pro iOS](https://github.com/fingerprintjs/fingerprintjs-pro-ios)
- [Fingerprint Pro Android](https://github.com/fingerprintjs/fingerprintjs-pro-android)
## How to install
### 1. Install the package using your favorite package manager:
* [NPM](https://npmjs.org):
```shell
npm install @fingerprintjs/fingerprintjs-pro-react-native --save
```
* [Yarn](https://yarnpkg.com):
```shell
yarn add @fingerprintjs/fingerprintjs-pro-react-native
```
* [PNPM](https://pnpm.js.org):
```shell
pnpm add @fingerprintjs/fingerprintjs-pro-react-native
```
### 2. Configure native dependencies
* **iOS**
```shell
cd ios && pod install
```
* **Android**
Add a declaration of the Fingerprint Android repository to your app main `build.gradle` file to the `allprojects` section:
```groovy
maven {
url("https://maven.fpregistry.io/releases")
}
maven {
url("https://www.jitpack.io")
}
```
The file location is `{rootDir}/android/build.gradle`.
After the changes the `build.gradle` file should look as following:
```groovy
allprojects {
repositories {
mavenCentral()
mavenLocal()
maven {
// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
url("$rootDir/../node_modules/react-native/android")
}
maven {
// Android JSC is installed from npm
url("$rootDir/../node_modules/jsc-android/dist")
}
maven {
url("https://maven.fpregistry.io/releases")
}
maven {
url("https://www.jitpack.io")
}
google()
}
}
```
## Usage
To identify visitors, you need a Fingerprint Pro account (you can [sign up for free](https://dashboard.fingerprint.com/signup/)).
- Go to [the Fingerprint Pro dashboard](https://dashboard.fingerprint.com/).
- Open **App Settings** > **API Keys** to find your Public API key.
### Hooks approach
Configure the SDK by wrapping your application in FingerprintJsProProvider.
```javascript
// src/index.js
import React from 'react';
import { AppRegistry } from 'react-native';
import { FingerprintJsProProvider } from '@fingerprintjs/fingerprintjs-pro-react-native';
import App from './App';
const WrappedApp = () => (
);
AppRegistry.registerComponent('AppName', () => WrappedApp);
```
Use the `useVisitorData` hook in your components to perform visitor identification and get the data.
```javascript
// src/App.js
import React, { useEffect } from 'react';
import { Text } from 'react-native';
import { useVisitorData } from '@fingerprintjs/fingerprintjs-pro-react-native';
function App() {
const {
isLoading,
error,
data,
getData,
} = useVisitorData();
useEffect(() => {
getData();
}, []);
if (isLoading) {
return Loading...;
}
if (error) {
return An error occured: {error.message};
}
if (data) {
// perform some logic based on the visitor data
return (
Visitor id is {data.visitorId}
);
} else {
return null;
}
}
export default App;
```
### API Client approach
```javascript
import React, { useEffect } from 'react';
import { FingerprintJsProAgent } from '@fingerprintjs/fingerprintjs-pro-react-native';
// ...
useEffect(() => {
async function getVisitorInfo() {
try {
const FingerprintClient = new FingerprintJsProAgent({ apiKey: 'PUBLIC_API_KEY', region: 'eu' }); // Region may be 'us', 'eu', or 'ap'
const visitorId = await FingerprintClient.getVisitorId(); // Use this method if you need only visitorId
const visitorData = await FingerprintClient.getVisitorData(); // Use this method if you need additional information about visitor
// use visitor data in your code
} catch (e) {
console.error('Error: ', e);
}
}
getVisitorInfo();
}, []);
```
### `extendedResponseFormat`
Two types of responses are supported: "default" and "extended". You don't need to pass any parameters to get the "default" response.
"Extended" is an extended result format that includes geolocation, incognito mode and other information.
It can be requested using the `extendedResponseFormat`: true parameter. See more details about the responses in the [documentation](https://dev.fingerprint.com/reference/get-function#extendedresult).
#### Providing `extendedResponseFormat` with hooks approach
```javascript
return (
)
```
#### Providing `extendedResponseFormat` with API Client approach
```javascript
const FingerprintClient = new FingerprintJsProAgent({ apiKey: 'PUBLIC_API_KEY', region: 'eu', extendedResponseFormat: true }); // Region may be 'us', 'eu', or 'ap'
// =================================================================================================^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```
### Linking and tagging information
The `visitorId` provided by Fingerprint Identification is especially useful when combined with information you already know about your users, for example, account IDs, order IDs, etc. To learn more about various applications of the `linkedId` and `tag`, see [Linking and tagging information](https://dev.fingerprint.com/docs/tagging-information).
```javascript
const tag = {
userAction: 'login',
analyticsId: 'UA-5555-1111-1'
};
const linkedId = 'user_1234';
// Using hooks
const { getData } = useVisitorData();
const visitorData = await getData(tag, linkedId);
// Using the client
const FingerprintClient = new FingerprintJsProAgent({ apiKey: 'PUBLIC_API_KEY'});
const visitorId = await FingerprintClient.getVisitorId(tag, linkedId);
const visitor = await FingerprintClient.getVisitorData(tag, linkedId);
```
## API Reference
See the full [generated API Reference](https://fingerprintjs.github.io/fingerprintjs-pro-react-native/).
## Additional Resources
- [Server-to-Server API](https://dev.fingerprint.com/docs/server-api)
- [Fingerprint Pro documentation](https://dev.fingerprint.com/docs)
## Support and feedback
To report problems, ask questions or provide feedback, please
use [Issues](https://github.com/fingerprintjs/fingerprintjs-pro-react-native/issues). If you need private support,
please email us at `[email protected]`.
## License
This project is licensed under the [MIT license](https://github.com/fingerprintjs/fingerprintjs-pro-react-native/blob/main/LICENSE).