Installation & Setup for React Native Applications

The ZSM Client SDK provides programmatic access to Ideem's FIDO2 Authentication functionality. This guide walks you through installing and configuring the SDK in a React Native project.

Step 1: Install the NPM Package

Run the following command from your project directory to install the ZSM Client SDK:

npm install @ideem/zsm-react-native --save

After installation, verify that your package.json includes (#.#.## will depend on the version installed):

"dependencies": {
    "@ideem/zsm-react-native": "^#.#.##"
}

Step 2: Import the ZSM Client SDK

Import the required client from the ZSM Client SDK into your React Native application:

FIDO2 Client:

import { FIDO2Client } from '@ideem/zsm-react-native';

Step 3: Set Up the Configuration File

Create a JSON configuration file or define a configuration object within your application. It should contain the following properties:

{
    "application_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    "host_url": "https://zsm-authenticator-demo.useideem.com/",
    "application_environment": "TEST",
    "api_key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

Configuration Properties

Property NameData TypeDescriptionExample Value
application_idstringUnique application identifier provided by Ideem.123e4567-e89b-12d3-a456-426614174000
host_urlstringURL of the region-specific ZSM server provided by Ideem.https://zsm-authenticator-demo.useideem.com/
application_environmentstringEnvironment setting (TEST or PRODUCTION).TEST
api_keystringAPI key for authentication, provided by Ideem.33214443-c760-4f8e-924e-9a2ad5cb0bf6

These values will be provided by Ideem. Sample configurations for testing environments are included in the SDK's examples.


Step 4: Initialize the SDK

After importing the SDK and setting up the configuration file, initialize the client with the configuration object:

FIDO2 Client Initialization:

const client = new FIDO2Client(config);

Pass the config object defined in Step 3 into the initialization. This connects your application to the ZSM services using your credentials.