Sign up! We’ll send you a link to your component, set up your Onymos Cloud Account, and generate your Onymos license credentials. In the meantime, you can get familiar with our API Documentation and developer resources, or join a whole community of developers building apps with Onymos on Reddit!

Add your components to a folder in your app’s root (e.g., onymos_components).

Add the Onymos Initialize component to your environment.

$ cordova plugin add onymos_components/onymos-component-initialize

Then we can add the Onymos Biometrics component.

$ cordova plugin add onymos_components/onymos-component-bioauth

Then update the widget inside your config.xml with the Onymos Widget ID you receive after you create an Onymos Cloud Account.

Use the Onymos Biometrics component to level up your app’s security!

Before we use Biometrics, let’s make sure we have everything we need to configure your onymosConnectObject. The onymosConnectObject requires the appropriate Onymos license credentials: your Customer ID (also called an Onymos ID) and your Onymos Auth Token. You’ll need these credentials to use this (or any) component in your app.

Next, let’s go inside your Cordova app’s index.js file and initialize Biometrics.

var OnymosInitalize
var OnymosBioauth

document.addEventListener('deviceready', onDeviceReady, false);

function onDeviceReady() {
  const OnymosConnectObject={
    customerId : 'Your customerId goes here', 
    onymosAuthToken : 'Your onymosAuthToken goes here',  
    envType: 'PRD'
  }

  OnymosInitialize.initialize(
    OnymosConnectObject,
      
    function onymosInitializeSuccess(status){
      console.log("Onymos initialized Successfully.", status)
    },

    function onymosInitializeFailure(error){
      console.log("Onymos failed to initialize.", error)
    })
}

Great! If we configured your onymosConnectObject correctly, onymosInitializeSuccess() should print its message to the console. Now we’re ready to use Biometrics.

Let’s create our own function called isAvailable() in the index.js file. We’ll use it to invoke the isAvailable() method on Biometrics.

function isAvailable(){
  OnymosBioauth.isAvailable(

    function isAvailableSuccess(bioauthAvailable, bioauthTypeObj) {
      console.log(bioauthAvailable, bioauthTypeObj)
      // bioauthTypeObj is only available on iOS devices.
    },

    function isAvailableFailure(error) {
      console.log(error)
    })
}

BioauthAvailable is a boolean that describes whether or not a device can use bio authentication. BioauthTypeObj is an object that describes what kind of bio authentication is available on a device. Let’s leverage bio authentication on devices that can use it!

Create another function in the index.js file called authenticate() that will invoke the Biometrics method of the same name.

function authenticate(){
  OnymosBioauth.authenticate(

    function authenticateSuccess(status) {
      console.log(status)
    },

    function authenticateFailure (error) {
      console.log(error)
    },

    options)
}

The authenticate() method includes several options for you to consider. Let’s incorporate a few—you can check out the Biometrics API documentation to learn more about all of them!

function authenticate(){
  OnymosBioauth.authenticate(
  
    function authenticateSuccess(status) {
      console.log(status)
    },
  
    function authenticateFailure (error) {
      console.log(error)
    },
  
    {
      disableFallback: true,
      fallbackText: 'Enter Pin',
    })
}

With disableFallback set to false, a user can take advantage of their device’s system fallback when they can’t, or don’t want to, bio authenticate. The fallbackText string will appear on the fallback button.

With just these two functions, your app is ready to deliver cutting-edge security to your users!

How do I squash this bug? Is Ionic supposed to do that? Why is this iOS build failing?

Let’s figure it out—join the Onymos community on Reddit! More of a loner? You can email us directly at customersuccess@onymos.com.